{ "current_page": 1, "data": [ { "id": 1, "name": "Lead", "color": "C4F4BE", "position": 1, "description": "A lead is any person or information acquired for a potential business transaction, whose potential hasn't been determined yet." }, { "id": 10, "name": "Prospect", "color": "2AA21D", "position": 2, "description": "A prospect is a lead whose potential has been evaluated and determined to be good — a qualified, interested lead." }, { "id": 3, "name": "Production", "color": "E67BF7", "position": 8, "description": null } ], "first_page_url": "https://api.contractorscloud.com/api/v1/meta/available-options/project-status?page[number]=1", "from": 1, "last_page": 1, "last_page_url": "https://api.contractorscloud.com/api/v1/meta/available-options/project-status?page[number]=1", "links": [ { "url": null, "label": "« Previous", "active": false }, { "url": "https://api.contractorscloud.com/api/v1/meta/available-options/project-status?page[number]=1", "label": "1", "active": true }, { "url": null, "label": "Next »", "active": false } ], "next_page_url": null, "path": "https://api.contractorscloud.com/api/v1/meta/available-options/project-status", "per_page": 30, "prev_page_url": null, "to": 3, "total": 3}
{
"message": "\"foo-bar\" is invalid. Available types are: title, site-type, file-type, project-status, note-type, permit-status, appointment-result, appointment-type, work-order-status"
}
Meta
List available options
Returns your organization-independent reference data for the given type — the same lookup values used across other endpoints wherever they accept an id such as appointment_result_id, the type_id on project notes, permit_status_id, or site_type_id. These values are system-level constants, identical for every organization, and no authentication is required to read them.
Results
title — relationship options for an account’s primary_title_id, secondary_title_id, and tertiary_title_id.
site-type — options for a project’s site_type_id.
file-type — folder categories used to organize a project’s files (description holds the human-readable folder label such as “Work Order”, while name holds a short internal key).
project-status — pipeline statuses for a project’s status_id, each with a fixed display color.
note-type — category options available when creating a note.
permit-status — status options for a permit.
appointment-result — outcomes you can record on a completed appointment through Update appointment.
appointment-type — type classification options for an appointment.
work-order-status — status options for a work order.
Request format
title, site-type, file-type, project-status, note-type, and permit-status support filter[id], filter[name], and sorting by name; file-type additionally supports filter[description] and sorting by id or description; project-status additionally sorts by position; permit-status additionally sorts by order. appointment-result, appointment-type, and work-order-status don’t support any filtering, and appointment-result and appointment-type don’t support sorting; work-order-status results are always ordered by position, its default order. Requesting an unrecognized type returns a 422 response naming the available types.
GET
/
meta
/
available-options
/
{type}
List available options
curl --request GET \ --url https://api.contractorscloud.com/api/v1/meta/available-options/{type}
Field to sort by. Prefix with - for descending. Allowed: name for title, site-type, file-type, project-status, note-type, and permit-status; additionally id and description for file-type; position for project-status; order for permit-status. Not available for appointment-result or appointment-type.
Response
A paginated list of available options for the given type.
The option's id — use this value in the corresponding *_id field elsewhere in the API (for example, appointment_result_id, the type_id on project notes, permit_status_id, or site_type_id).
The display color associated with the option. Only present for project-status and work-order-status. For project-status this is always a 6-character hex code without a leading # (for example 2AA21D); for work-order-status it can be either a hex code with a leading # or a named color (for example #FF0033 or grey).
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Contractors Cloud API","colors":{"primary":"#2AA21D","light":"#3CC02B","dark":"#1F7A15"},"logo":{"light":"https://mintcdn.com/contractorscloud/INPGxFez8gWm8k6a/logo/light.svg?fit=max\u0026auto=format\u0026n=INPGxFez8gWm8k6a\u0026q=85\u0026s=97eb8332c827f6c4678c14649a08a274","dark":"https://mintcdn.com/contractorscloud/INPGxFez8gWm8k6a/logo/dark.svg?fit=max\u0026auto=format\u0026n=INPGxFez8gWm8k6a\u0026q=85\u0026s=b344e1c401468f0125bbf9c54580cb13"},"favicon":"https://mintcdn.com/contractorscloud/INPGxFez8gWm8k6a/favicon.png?fit=max\u0026auto=format\u0026n=INPGxFez8gWm8k6a\u0026q=85\u0026s=513db0316087f7c645b29f0d1e857a54","api":{"openapi":"openapi.yaml","params":{"expanded":"all"},"playground":{"display":"interactive"},"examples":{"defaults":"all"}},"navbar":{"links":[],"primary":{"type":"button","label":"Dashboard","href":"https://stratus.contractorscloud.com"}},"footer":{"socials":{"facebook":"https://www.facebook.com/contractorscloud","youtube":"https://www.youtube.com/channel/UCCuO9QepfcGzQNi4wieX2Rw"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"markdown":{"schema":true},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://contractorscloud.com/blog/"},{"anchor":"Status","icon":"heartbeat","href":"https://status.contractorscloud.com/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"contractorscloud","hasAudioNarration":false,"actualSubdomain":"contractorscloud","customDomains":["api.contractorscloud.com"],"gitSource":{"type":"github","owner":"thinkup-technologies","repo":"contractors-cloud-api-docs","deployBranch":"prod","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"collectionId":"8974e26a-0b28-4feb-8e5d-0fa9973ab8d1","liveDeploymentHistoryId":"6ad97b720a13aa97f4145f4f","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad97b720a13aa97f4145f4f"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ad97b720a13aa97f4145f4f","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"API Reference","count":204},{"language":"default","tag":"Reference","count":197},{"language":"default","tag":"Projects","count":69},{"language":"default","tag":"Types","count":51},{"language":"default","tag":"Resources","count":47},{"language":"default","tag":"Leads","count":30},{"language":"default","tag":"Companies","count":24},{"language":"default","tag":"Contacts","count":21},{"language":"default","tag":"Jet Streams","count":20},{"language":"default","tag":"Teams","count":19}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/meta/list-available-options","slug":"/api-reference/meta/list-available-options","pageMetadata":{"title":"List available options","description":"Returns your organization-independent reference data for the given `type` — the same lookup values used across other endpoints wherever they accept an id such as `appointment_result_id`, the `type_id` on project notes, `permit_status_id`, or `site_type_id`. These values are system-level constants, identical for every organization, and no authentication is required to read them.\n\n### Results\n\n- **title** — relationship options for an account's `primary_title_id`, `secondary_title_id`, and `tertiary_title_id`.\n- **site-type** — options for a project's `site_type_id`.\n- **file-type** — folder categories used to organize a project's files (`description` holds the human-readable folder label such as \"Work Order\", while `name` holds a short internal key).\n- **project-status** — pipeline statuses for a project's `status_id`, each with a fixed display `color`.\n- **note-type** — category options available when creating a note.\n- **permit-status** — status options for a permit.\n- **appointment-result** — outcomes you can record on a completed appointment through [Update appointment](/api-reference/appointments/update-appointment).\n- **appointment-type** — type classification options for an appointment.\n- **work-order-status** — status options for a work order.\n\n### Request format\n\n`title`, `site-type`, `file-type`, `project-status`, `note-type`, and `permit-status` support `filter[id]`, `filter[name]`, and sorting by `name`; `file-type` additionally supports `filter[description]` and sorting by `id` or `description`; `project-status` additionally sorts by `position`; `permit-status` additionally sorts by `order`. `appointment-result`, `appointment-type`, and `work-order-status` don't support any filtering, and `appointment-result` and `appointment-type` don't support sorting; `work-order-status` results are always ordered by `position`, its default order. Requesting an unrecognized `type` returns a `422` response naming the available types.","deprecated":null,"version":null,"openapi":"/openapi.yaml get /meta/available-options/{type}","href":"/api-reference/meta/list-available-options","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n code: \"code\",\n h3: \"h3\",\n li: \"li\",\n p: \"p\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Returns your organization-independent reference data for the given \", _jsx(_components.code, {\n children: \"type\"\n }), \" — the same lookup values used across other endpoints wherever they accept an id such as \", _jsx(_components.code, {\n children: \"appointment_result_id\"\n }), \", the \", _jsx(_components.code, {\n children: \"type_id\"\n }), \" on project notes, \", _jsx(_components.code, {\n children: \"permit_status_id\"\n }), \", or \", _jsx(_components.code, {\n children: \"site_type_id\"\n }), \". These values are system-level constants, identical for every organization, and no authentication is required to read them.\"]\n }), \"\\n\", _jsx(_components.h3, {\n children: \"Results\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"title\"\n }), \" — relationship options for an account’s \", _jsx(_components.code, {\n children: \"primary_title_id\"\n }), \", \", _jsx(_components.code, {\n children: \"secondary_title_id\"\n }), \", and \", _jsx(_components.code, {\n children: \"tertiary_title_id\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"site-type\"\n }), \" — options for a project’s \", _jsx(_components.code, {\n children: \"site_type_id\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"file-type\"\n }), \" — folder categories used to organize a project’s files (\", _jsx(_components.code, {\n children: \"description\"\n }), \" holds the human-readable folder label such as “Work Order”, while \", _jsx(_components.code, {\n children: \"name\"\n }), \" holds a short internal key).\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"project-status\"\n }), \" — pipeline statuses for a project’s \", _jsx(_components.code, {\n children: \"status_id\"\n }), \", each with a fixed display \", _jsx(_components.code, {\n children: \"color\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"note-type\"\n }), \" — category options available when creating a note.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"permit-status\"\n }), \" — status options for a permit.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"appointment-result\"\n }), \" — outcomes you can record on a completed appointment through \", _jsx(_components.a, {\n href: \"/api-reference/appointments/update-appointment\",\n children: \"Update appointment\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"appointment-type\"\n }), \" — type classification options for an appointment.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"work-order-status\"\n }), \" — status options for a work order.\"]\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.h3, {\n children: \"Request format\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"title\"\n }), \", \", _jsx(_components.code, {\n children: \"site-type\"\n }), \", \", _jsx(_components.code, {\n children: \"file-type\"\n }), \", \", _jsx(_components.code, {\n children: \"project-status\"\n }), \", \", _jsx(_components.code, {\n children: \"note-type\"\n }), \", and \", _jsx(_components.code, {\n children: \"permit-status\"\n }), \" support \", _jsx(_components.code, {\n children: \"filter[id]\"\n }), \", \", _jsx(_components.code, {\n children: \"filter[name]\"\n }), \", and sorting by \", _jsx(_components.code, {\n children: \"name\"\n }), \"; \", _jsx(_components.code, {\n children: \"file-type\"\n }), \" additionally supports \", _jsx(_components.code, {\n children: \"filter[description]\"\n }), \" and sorting by \", _jsx(_components.code, {\n children: \"id\"\n }), \" or \", _jsx(_components.code, {\n children: \"description\"\n }), \"; \", _jsx(_components.code, {\n children: \"project-status\"\n }), \" additionally sorts by \", _jsx(_components.code, {\n children: \"position\"\n }), \"; \", _jsx(_components.code, {\n children: \"permit-status\"\n }), \" additionally sorts by \", _jsx(_components.code, {\n children: \"order\"\n }), \". \", _jsx(_components.code, {\n children: \"appointment-result\"\n }), \", \", _jsx(_components.code, {\n children: \"appointment-type\"\n }), \", and \", _jsx(_components.code, {\n children: \"work-order-status\"\n }), \" don’t support any filtering, and \", _jsx(_components.code, {\n children: \"appointment-result\"\n }), \" and \", _jsx(_components.code, {\n children: \"appointment-type\"\n }), \" don’t support sorting; \", _jsx(_components.code, {\n children: \"work-order-status\"\n }), \" results are always ordered by \", _jsx(_components.code, {\n children: \"position\"\n }), \", its default order. Requesting an unrecognized \", _jsx(_components.code, {\n children: \"type\"\n }), \" returns a \", _jsx(_components.code, {\n children: \"422\"\n }), \" response naming the available types.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"List available options","description":"Returns your organization-independent reference data for the given `type` — the same lookup values used across other endpoints wherever they accept an id such as `appointment_result_id`, the `type_id` on project notes, `permit_status_id`, or `site_type_id`. These values are system-level constants, identical for every organization, and no authentication is required to read them.\n\n### Results\n\n- **title** — relationship options for an account's `primary_title_id`, `secondary_title_id`, and `tertiary_title_id`.\n- **site-type** — options for a project's `site_type_id`.\n- **file-type** — folder categories used to organize a project's files (`description` holds the human-readable folder label such as \"Work Order\", while `name` holds a short internal key).\n- **project-status** — pipeline statuses for a project's `status_id`, each with a fixed display `color`.\n- **note-type** — category options available when creating a note.\n- **permit-status** — status options for a permit.\n- **appointment-result** — outcomes you can record on a completed appointment through [Update appointment](/api-reference/appointments/update-appointment).\n- **appointment-type** — type classification options for an appointment.\n- **work-order-status** — status options for a work order.\n\n### Request format\n\n`title`, `site-type`, `file-type`, `project-status`, `note-type`, and `permit-status` support `filter[id]`, `filter[name]`, and sorting by `name`; `file-type` additionally supports `filter[description]` and sorting by `id` or `description`; `project-status` additionally sorts by `position`; `permit-status` additionally sorts by `order`. `appointment-result`, `appointment-type`, and `work-order-status` don't support any filtering, and `appointment-result` and `appointment-type` don't support sorting; `work-order-status` results are always ordered by `position`, its default order. Requesting an unrecognized `type` returns a `422` response naming the available types.","deprecated":null,"version":null,"openapi":"/openapi.yaml get /meta/available-options/{type}","href":"/api-reference/meta/list-available-options","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"listAvailableOptions","summary":"List available options","description":"Returns your organization-independent reference data for the given `type` — the same lookup values used across other endpoints wherever they accept an id such as `appointment_result_id`, the `type_id` on project notes, `permit_status_id`, or `site_type_id`. These values are system-level constants, identical for every organization, and no authentication is required to read them.\n\n### Results\n\n- **title** — relationship options for an account's `primary_title_id`, `secondary_title_id`, and `tertiary_title_id`.\n- **site-type** — options for a project's `site_type_id`.\n- **file-type** — folder categories used to organize a project's files (`description` holds the human-readable folder label such as \"Work Order\", while `name` holds a short internal key).\n- **project-status** — pipeline statuses for a project's `status_id`, each with a fixed display `color`.\n- **note-type** — category options available when creating a note.\n- **permit-status** — status options for a permit.\n- **appointment-result** — outcomes you can record on a completed appointment through [Update appointment](/api-reference/appointments/update-appointment).\n- **appointment-type** — type classification options for an appointment.\n- **work-order-status** — status options for a work order.\n\n### Request format\n\n`title`, `site-type`, `file-type`, `project-status`, `note-type`, and `permit-status` support `filter[id]`, `filter[name]`, and sorting by `name`; `file-type` additionally supports `filter[description]` and sorting by `id` or `description`; `project-status` additionally sorts by `position`; `permit-status` additionally sorts by `order`. `appointment-result`, `appointment-type`, and `work-order-status` don't support any filtering, and `appointment-result` and `appointment-type` don't support sorting; `work-order-status` results are always ordered by `position`, its default order. Requesting an unrecognized `type` returns a `422` response naming the available types.","security":[],"tags":["Meta"],"parameters":["36170aa6-84b0-4d4f-80ed-1827ed9dc0c8","d0719964-44c9-4282-a249-8b7c040e6e09","7bffdadd-599f-4794-8433-0522e991a2cc","f4628cc3-1af7-4599-8615-8b51b8ce6034","91036605-079d-4abe-b08b-e0c60032b1fb","8226adb7-1767-4857-8975-a01d4ff0451d","7aca72db-ea93-4991-b46e-b1f269c31d3a"],"responses":{"200":"d23fc391-9b95-4f67-b8dc-7ec5d912a9e3","422":"7efab0ab-c039-4fd3-8eee-1ebb05e8cbc7"},"method":"get","type":"path","servers":["d40a5874-0065-43ae-a49c-61cdcc45656d"],"path":"/meta/available-options/{type}","baseUrlOptions":["https://api.contractorscloud.com/api/v1"],"title":"List available options","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"36170aa6-84b0-4d4f-80ed-1827ed9dc0c8":{"name":"type","in":"path","required":true,"description":"The category of reference data to list.","schema":{"type":"string","enum":["title","site-type","file-type","project-status","note-type","permit-status","appointment-result","appointment-type","work-order-status"],"isRequired":true,"description":"The category of reference data to list.","uniqueKey":"","typeLabel":"enum\u003cstring>"},"example":"project-status"},"d0719964-44c9-4282-a249-8b7c040e6e09":{"name":"page[number]","in":"query","description":"The 1-indexed page number to retrieve.","schema":{"type":"integer","default":1,"minimum":1,"description":"The 1-indexed page number to retrieve.","uniqueKey":"","typeLabel":"integer"}},"7bffdadd-599f-4794-8433-0522e991a2cc":{"name":"page[size]","in":"query","description":"The number of results per page (max 100).","schema":{"type":"integer","default":30,"minimum":1,"maximum":100,"description":"The number of results per page (max 100).","uniqueKey":"","typeLabel":"integer"}},"f4628cc3-1af7-4599-8615-8b51b8ce6034":{"name":"filter[id]","in":"query","description":"Exact match on the option's id. Not available for `appointment-result`, `appointment-type`, or `work-order-status`.","schema":{"type":"integer","description":"Exact match on the option's id. Not available for `appointment-result`, `appointment-type`, or `work-order-status`.","uniqueKey":"","typeLabel":"integer"}},"91036605-079d-4abe-b08b-e0c60032b1fb":{"name":"filter[name]","in":"query","description":"Partial match on the option's name. Not available for `appointment-result`, `appointment-type`, or `work-order-status`.","schema":{"type":"string","description":"Partial match on the option's name. Not available for `appointment-result`, `appointment-type`, or `work-order-status`.","uniqueKey":"","typeLabel":"string"}},"8226adb7-1767-4857-8975-a01d4ff0451d":{"name":"filter[description]","in":"query","description":"Partial match on the option's description. Only available for `file-type`.","schema":{"type":"string","description":"Partial match on the option's description. Only available for `file-type`.","uniqueKey":"","typeLabel":"string"}},"7aca72db-ea93-4991-b46e-b1f269c31d3a":{"name":"sort","in":"query","description":"Field to sort by. Prefix with `-` for descending. Allowed: `name` for `title`, `site-type`, `file-type`, `project-status`, `note-type`, and `permit-status`; additionally `id` and `description` for `file-type`; `position` for `project-status`; `order` for `permit-status`. Not available for `appointment-result` or `appointment-type`.","schema":{"type":"string","description":"Field to sort by. Prefix with `-` for descending. Allowed: `name` for `title`, `site-type`, `file-type`, `project-status`, `note-type`, and `permit-status`; additionally `id` and `description` for `file-type`; `position` for `project-status`; `order` for `permit-status`. Not available for `appointment-result` or `appointment-type`.","uniqueKey":"","typeLabel":"string"},"example":"name"}},"responses":{"d23fc391-9b95-4f67-b8dc-7ec5d912a9e3":{"description":"A paginated list of available options for the given type.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"The option's id — use this value in the corresponding `*_id` field elsewhere in the API (for example, `appointment_result_id`, the `type_id` on project notes, `permit_status_id`, or `site_type_id`).","example":3,"uniqueKey":"data.items.[INDEX].id","typeLabel":"integer"},"name":{"type":"string","description":"The option's display name.","example":"Production","uniqueKey":"data.items.[INDEX].name","typeLabel":"string"},"description":{"oneOf":[{"type":"string","description":"A longer description of the option. Only present for `file-type` and `project-status`. Null if not set.","uniqueKey":"data.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","description":"A longer description of the option. Only present for `file-type` and `project-status`. Null if not set.","uniqueKey":"data.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].description","typeLabel":"string | null"},"color":{"type":"string","description":"The display color associated with the option. Only present for `project-status` and `work-order-status`. For `project-status` this is always a 6-character hex code without a leading `#` (for example `2AA21D`); for `work-order-status` it can be either a hex code with a leading `#` or a named color (for example `#FF0033` or `grey`).","uniqueKey":"data.items.[INDEX].color","typeLabel":"string"},"position":{"type":"integer","description":"The option's position in its display order, lower values first. Only present for `project-status`, `appointment-result`, and `work-order-status`.","uniqueKey":"data.items.[INDEX].position","typeLabel":"integer"},"order":{"type":"integer","description":"The option's position in its display order, lower values first. Only present for `permit-status`.","uniqueKey":"data.items.[INDEX].order","typeLabel":"integer"},"appointment_category_id":{"type":"integer","description":"The id of the appointment category this appointment type belongs to. Only present for `appointment-type`.","uniqueKey":"data.items.[INDEX].appointment_category_id","typeLabel":"integer"}},"uniqueKey":"data.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data","typeLabel":"object[]"},"current_page":{"type":"integer","description":"The 1-indexed page number of the current response.","example":1,"uniqueKey":"current_page","typeLabel":"integer"},"first_page_url":{"type":"string","description":"The URL of the first page of results.","uniqueKey":"first_page_url","typeLabel":"string"},"from":{"oneOf":[{"type":"integer","description":"The 1-indexed position of the first record in `data` for this page. Null when the page is empty.","example":1,"uniqueKey":"from.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The 1-indexed position of the first record in `data` for this page. Null when the page is empty.","example":1,"uniqueKey":"from.oneOf.1","typeLabel":"null"}],"uniqueKey":"from","typeLabel":"integer | null"},"last_page":{"type":"integer","description":"The number of the final page in the result set.","example":4,"uniqueKey":"last_page","typeLabel":"integer"},"last_page_url":{"type":"string","description":"The URL of the last page of results.","uniqueKey":"last_page_url","typeLabel":"string"},"links":{"type":"array","description":"Rendered pagination links (previous, numbered pages, next).","items":{"type":"object","properties":{"url":{"oneOf":[{"type":"string","description":"The target URL for this link, or `null` if the link isn't clickable (for example, the current page).","uniqueKey":"links.items.[INDEX].url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The target URL for this link, or `null` if the link isn't clickable (for example, the current page).","uniqueKey":"links.items.[INDEX].url.oneOf.1","typeLabel":"null"}],"uniqueKey":"links.items.[INDEX].url","typeLabel":"string | null"},"label":{"type":"string","description":"Display label for the link, such as a page number or `Next »`.","uniqueKey":"links.items.[INDEX].label","typeLabel":"string"},"active":{"type":"boolean","description":"Whether this link represents the current page.","uniqueKey":"links.items.[INDEX].active","typeLabel":"boolean"}},"uniqueKey":"links.items.[INDEX]","typeLabel":"object"},"uniqueKey":"links","typeLabel":"object[]"},"next_page_url":{"oneOf":[{"type":"string","description":"The URL of the next page, or `null` if this is the last page.","uniqueKey":"next_page_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL of the next page, or `null` if this is the last page.","uniqueKey":"next_page_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_page_url","typeLabel":"string | null"},"path":{"type":"string","description":"The endpoint URL without query parameters.","uniqueKey":"path","typeLabel":"string"},"per_page":{"type":"integer","description":"The number of records requested per page.","example":30,"uniqueKey":"per_page","typeLabel":"integer"},"prev_page_url":{"oneOf":[{"type":"string","description":"The URL of the previous page, or `null` if this is the first page.","uniqueKey":"prev_page_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL of the previous page, or `null` if this is the first page.","uniqueKey":"prev_page_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"prev_page_url","typeLabel":"string | null"},"to":{"oneOf":[{"type":"integer","description":"The 1-indexed position of the last record in `data` for this page. Null when the page is empty.","example":30,"uniqueKey":"to.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The 1-indexed position of the last record in `data` for this page. Null when the page is empty.","example":30,"uniqueKey":"to.oneOf.1","typeLabel":"null"}],"uniqueKey":"to","typeLabel":"integer | null"},"total":{"type":"integer","description":"The total number of records across all pages.","example":97,"uniqueKey":"total","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"object"},"example":{"current_page":1,"data":[{"id":1,"name":"Lead","color":"C4F4BE","position":1,"description":"A lead is any person or information acquired for a potential business transaction, whose potential hasn't been determined yet."},{"id":10,"name":"Prospect","color":"2AA21D","position":2,"description":"A prospect is a lead whose potential has been evaluated and determined to be good — a qualified, interested lead."},{"id":3,"name":"Production","color":"E67BF7","position":8,"description":null}],"first_page_url":"https://api.contractorscloud.com/api/v1/meta/available-options/project-status?page[number]=1","from":1,"last_page":1,"last_page_url":"https://api.contractorscloud.com/api/v1/meta/available-options/project-status?page[number]=1","links":[{"url":null,"label":"\u0026laquo; Previous","active":false},{"url":"https://api.contractorscloud.com/api/v1/meta/available-options/project-status?page[number]=1","label":"1","active":true},{"url":null,"label":"Next \u0026raquo;","active":false}],"next_page_url":null,"path":"https://api.contractorscloud.com/api/v1/meta/available-options/project-status","per_page":30,"prev_page_url":null,"to":3,"total":3},"examples":{"Example":{"title":"Example","value":{"current_page":1,"data":[{"id":1,"name":"Lead","color":"C4F4BE","position":1,"description":"A lead is any person or information acquired for a potential business transaction, whose potential hasn't been determined yet."},{"id":10,"name":"Prospect","color":"2AA21D","position":2,"description":"A prospect is a lead whose potential has been evaluated and determined to be good — a qualified, interested lead."},{"id":3,"name":"Production","color":"E67BF7","position":8,"description":null}],"first_page_url":"https://api.contractorscloud.com/api/v1/meta/available-options/project-status?page[number]=1","from":1,"last_page":1,"last_page_url":"https://api.contractorscloud.com/api/v1/meta/available-options/project-status?page[number]=1","links":[{"url":null,"label":"\u0026laquo; Previous","active":false},{"url":"https://api.contractorscloud.com/api/v1/meta/available-options/project-status?page[number]=1","label":"1","active":true},{"url":null,"label":"Next \u0026raquo;","active":false}],"next_page_url":null,"path":"https://api.contractorscloud.com/api/v1/meta/available-options/project-status","per_page":30,"prev_page_url":null,"to":3,"total":3}}},"exampleType":"examples"}},"exampleType":"examples"},"7efab0ab-c039-4fd3-8eee-1ebb05e8cbc7":{"description":"The given `type` isn't one of the available types.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"A human-readable description of the error.","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"\"foo-bar\" is invalid. Available types are: title, site-type, file-type, project-status, note-type, permit-status, appointment-result, appointment-type, work-order-status"},"examples":{"Example":{"title":"Example","value":{"message":"\"foo-bar\" is invalid. Available types are: title, site-type, file-type, project-status, note-type, permit-status, appointment-result, appointment-type, work-order-status"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{},"servers":{"d40a5874-0065-43ae-a49c-61cdcc45656d":{"url":"https://api.contractorscloud.com/api/v1","description":"Production"}}},"originalFileLocation":"openapi.yaml"},"subdomain":"contractorscloud","siteName":"Contractors Cloud API","title":"List available options - Contractors Cloud API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-09T16:01:43.924Z","originalFileLocation":"api-reference/meta/list-available-options.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns your organization-independent reference data for the given type — the same lookup values used across other endpoints wherever they accept an id such as appointment_result_id, the type_id on project notes, permit_status_id, or site_type_id. These values are system-level constants, identical for every organization, and no authentication is required to read them. ### Results - title — relationship options for an account\u0026#x27;s primary_title_id, secondary_title_id, and tertiary_title_id. - site-type — options for a project\u0026#x27;s site_type_id. - file-type — folder categories used to organize a project\u0026#x27;s files (description holds the human-readable folder label such as \u0026quot;Work Order\u0026quot;, while name holds a short internal key). - project-status — pipeline statuses for a project\u0026#x27;s status_id, each with a fixed display color. - note-type — category options available when creating a note. - permit-status — status options for a permit. - appointment-result — outcomes you can record on a completed appointment through Update appointment. - appointment-type — type classification options for an appointment. - work-order-status — status options for a work order. ### Request format title, site-type, file-type, project-status, note-type, and permit-status support filter[id], filter[name], and sorting by name; file-type additionally supports filter[description] and sorting by id or description; project-status additionally sorts by position; permit-status additionally sorts by order. appointment-result, appointment-type, and work-order-status don\u0026#x27;t support any filtering, and appointment-result and appointment-type don\u0026#x27;t support sorting; work-order-status results are always ordered by position, its default order. Requesting an unrecognized type returns a 422 response naming the available types.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Contractors Cloud API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/contractorscloud/2XG7UY1SFiDHDzBw/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/docs/mintlify-assets/_mintlify/favicons/contractorscloud/2XG7UY1SFiDHDzBw/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/contractorscloud/2XG7UY1SFiDHDzBw/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/contractorscloud/2XG7UY1SFiDHDzBw/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/contractorscloud/2XG7UY1SFiDHDzBw/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/contractorscloud/2XG7UY1SFiDHDzBw/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/contractorscloud/2XG7UY1SFiDHDzBw/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/contractorscloud/2XG7UY1SFiDHDzBw/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/contractorscloud/2XG7UY1SFiDHDzBw/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List available options - Contractors Cloud API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns your organization-independent reference data for the given type — the same lookup values used across other endpoints wherever they accept an id such as appointment_result_id, the type_id on project notes, permit_status_id, or site_type_id. These values are system-level constants, identical for every organization, and no authentication is required to read them. ### Results - title — relationship options for an account\u0026#x27;s primary_title_id, secondary_title_id, and tertiary_title_id. - site-type — options for a project\u0026#x27;s site_type_id. - file-type — folder categories used to organize a project\u0026#x27;s files (description holds the human-readable folder label such as \u0026quot;Work Order\u0026quot;, while name holds a short internal key). - project-status — pipeline statuses for a project\u0026#x27;s status_id, each with a fixed display color. - note-type — category options available when creating a note. - permit-status — status options for a permit. - appointment-result — outcomes you can record on a completed appointment through Update appointment. - appointment-type — type classification options for an appointment. - work-order-status — status options for a work order. ### Request format title, site-type, file-type, project-status, note-type, and permit-status support filter[id], filter[name], and sorting by name; file-type additionally supports filter[description] and sorting by id or description; project-status additionally sorts by position; permit-status additionally sorts by order. appointment-result, appointment-type, and work-order-status don\u0026#x27;t support any filtering, and appointment-result and appointment-type don\u0026#x27;t support sorting; work-order-status results are always ordered by position, its default order. Requesting an unrecognized type returns a 422 response naming the available types.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Contractors Cloud API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://api.contractorscloud.com/docs/api-reference/meta/list-available-options\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://contractorscloud.mintlify.app/_mintlify/api/og/v2?division=Meta\u0026amp;title=List+available+options\u0026amp;description=Returns+your+organization-independent+reference+data+for+the+given+%60type%60+%E2%80%94+the+same+lookup+values+used+across+other+endpoints+wherever+they+accept+an+id+such+a\u0026amp;theme=3408b2ae85cc8e2bb563fd2e\u0026amp;signature=13d79a91509520d05883356990fecc084edf1390d4456344147adbd432ee338c\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"List available options - Contractors Cloud API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns your organization-independent reference data for the given type — the same lookup values used across other endpoints wherever they accept an id such as appointment_result_id, the type_id on project notes, permit_status_id, or site_type_id. These values are system-level constants, identical for every organization, and no authentication is required to read them. ### Results - title — relationship options for an account\u0026#x27;s primary_title_id, secondary_title_id, and tertiary_title_id. - site-type — options for a project\u0026#x27;s site_type_id. - file-type — folder categories used to organize a project\u0026#x27;s files (description holds the human-readable folder label such as \u0026quot;Work Order\u0026quot;, while name holds a short internal key). - project-status — pipeline statuses for a project\u0026#x27;s status_id, each with a fixed display color. - note-type — category options available when creating a note. - permit-status — status options for a permit. - appointment-result — outcomes you can record on a completed appointment through Update appointment. - appointment-type — type classification options for an appointment. - work-order-status — status options for a work order. ### Request format title, site-type, file-type, project-status, note-type, and permit-status support filter[id], filter[name], and sorting by name; file-type additionally supports filter[description] and sorting by id or description; project-status additionally sorts by position; permit-status additionally sorts by order. appointment-result, appointment-type, and work-order-status don\u0026#x27;t support any filtering, and appointment-result and appointment-type don\u0026#x27;t support sorting; work-order-status results are always ordered by position, its default order. Requesting an unrecognized type returns a 422 response naming the available types.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://contractorscloud.mintlify.app/_mintlify/api/og/v2?division=Meta\u0026amp;title=List+available+options\u0026amp;description=Returns+your+organization-independent+reference+data+for+the+given+%60type%60+%E2%80%94+the+same+lookup+values+used+across+other+endpoints+wherever+they+accept+an+id+such+a\u0026amp;theme=3408b2ae85cc8e2bb563fd2e\u0026amp;signature=13d79a91509520d05883356990fecc084edf1390d4456344147adbd432ee338c\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/contractorscloud/2XG7UY1SFiDHDzBw/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Contractors Cloud API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2AA21D\">\u003clink data-mint-head rel=\"canonical\" href=\"https://api.contractorscloud.com/docs/api-reference/meta/list-available-options\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/meta/list-available-options.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://api.contractorscloud.com/#organization\",\"name\":\"Contractors Cloud API\",\"url\":\"https://api.contractorscloud.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/contractorscloud/INPGxFez8gWm8k6a/logo/light.svg?fit=max\u0026auto=format\u0026n=INPGxFez8gWm8k6a\u0026q=85\u0026s=97eb8332c827f6c4678c14649a08a274\"}},{\"@type\":\"WebSite\",\"@id\":\"https://api.contractorscloud.com/docs#website\",\"name\":\"Contractors Cloud API\",\"url\":\"https://api.contractorscloud.com/docs\",\"publisher\":{\"@id\":\"https://api.contractorscloud.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://api.contractorscloud.com/docs/api-reference/meta/list-available-options#webpage\",\"url\":\"https://api.contractorscloud.com/docs/api-reference/meta/list-available-options\",\"name\":\"List available options\",\"description\":\"Returns your organization-independent reference data for the given type — the same lookup values used across other endpoints wherever they accept an id such as appointment_result_id, the type_id on project notes, permit_status_id, or site_type_id. These values are system-level constants, identical for every organization, and no authentication is required to read them. ### Results - title — relationship options for an account's primary_title_id, secondary_title_id, and tertiary_title_id. - site-type — options for a project's site_type_id. - file-type — folder categories used to organize a project's files (description holds the human-readable folder label such as \\\"Work Order\\\", while name holds a short internal key). - project-status — pipeline statuses for a project's status_id, each with a fixed display color. - note-type — category options available when creating a note. - permit-status — status options for a permit. - appointment-result — outcomes you can record on a completed appointment through Update appointment. - appointment-type — type classification options for an appointment. - work-order-status — status options for a work order. ### Request format title, site-type, file-type, project-status, note-type, and permit-status support filter[id], filter[name], and sorting by name; file-type additionally supports filter[description] and sorting by id or description; project-status additionally sorts by position; permit-status additionally sorts by order. appointment-result, appointment-type, and work-order-status don't support any filtering, and appointment-result and appointment-type don't support sorting; work-order-status results are always ordered by position, its default order. Requesting an unrecognized type returns a 422 response naming the available types.\",\"dateModified\":\"2026-10-09T16:01:43.924Z\",\"isPartOf\":{\"@id\":\"https://api.contractorscloud.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://api.contractorscloud.com/docs/api-reference/meta/list-available-options#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://api.contractorscloud.com/docs/api-reference/meta/list-available-options#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Reference\",\"item\":\"https://api.contractorscloud.com/docs/api-reference/projects/list-projects\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List available options\",\"item\":\"https://api.contractorscloud.com/docs/api-reference/meta/list-available-options\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://api.contractorscloud.com/docs/api-reference/meta/list-available-options#apireference\",\"headline\":\"List available options\",\"name\":\"List available options\",\"description\":\"Returns your organization-independent reference data for the given type — the same lookup values used across other endpoints wherever they accept an id such as appointment_result_id, the type_id on project notes, permit_status_id, or site_type_id. These values are system-level constants, identical for every organization, and no authentication is required to read them. ### Results - title — relationship options for an account's primary_title_id, secondary_title_id, and tertiary_title_id. - site-type — options for a project's site_type_id. - file-type — folder categories used to organize a project's files (description holds the human-readable folder label such as \\\"Work Order\\\", while name holds a short internal key). - project-status — pipeline statuses for a project's status_id, each with a fixed display color. - note-type — category options available when creating a note. - permit-status — status options for a permit. - appointment-result — outcomes you can record on a completed appointment through Update appointment. - appointment-type — type classification options for an appointment. - work-order-status — status options for a work order. ### Request format title, site-type, file-type, project-status, note-type, and permit-status support filter[id], filter[name], and sorting by name; file-type additionally supports filter[description] and sorting by id or description; project-status additionally sorts by position; permit-status additionally sorts by order. appointment-result, appointment-type, and work-order-status don't support any filtering, and appointment-result and appointment-type don't support sorting; work-order-status results are always ordered by position, its default order. Requesting an unrecognized type returns a 422 response naming the available types.\",\"url\":\"https://api.contractorscloud.com/docs/api-reference/meta/list-available-options\",\"mainEntityOfPage\":{\"@id\":\"https://api.contractorscloud.com/docs/api-reference/meta/list-available-options#webpage\"},\"dateModified\":\"2026-10-09T16:01:43.924Z\",\"publisher\":{\"@id\":\"https://api.contractorscloud.com/#organization\"},\"isPartOf\":{\"@id\":\"https://api.contractorscloud.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Contractors Cloud API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Contractors Cloud API","nav":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://contractorscloud.com/blog/"},{"anchor":"Status","icon":"heartbeat","href":"https://status.contractorscloud.com/"}]},"tabs":[{"tab":"API Reference","icon":"square-terminal","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","href":""},{"title":"Filtering and sorting","href":"/filtering-and-sorting"},{"title":"Relationships","href":"/relationships"},{"title":"Pagination","href":"/pagination"},{"title":"Rate limiting","href":"/rate-limiting"},{"title":"Versioning and stability","sidebarTitle":"Versioning","href":"/versioning"},{"title":"Security","href":"/security"}]},{"group":"Reference","pages":[{"group":"Projects","pages":[{"title":"List projects","deprecated":null,"version":null,"openapi":"/openapi.yaml get /projects","href":"/api-reference/projects/list-projects"},{"title":"Create project","deprecated":null,"version":null,"openapi":"/openapi.yaml post /projects","href":"/api-reference/projects/create-project"},{"title":"Get project","deprecated":null,"version":null,"openapi":"/openapi.yaml get /projects/{projectId}","href":"/api-reference/projects/get-project"},{"title":"Update project","deprecated":null,"version":null,"openapi":"/openapi.yaml put /projects/{projectId}","href":"/api-reference/projects/update-project"},{"title":"Delete project","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /projects/{projectId}","href":"/api-reference/projects/delete-project"},{"group":"Contacts","expanded":false,"pages":[{"title":"List project contacts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /projects/{projectId}/contacts","href":"/api-reference/project-contacts/list-project-contacts"},{"title":"Create project contact","deprecated":null,"version":null,"openapi":"/openapi.yaml post /projects/{projectId}/contacts","href":"/api-reference/project-contacts/create-project-contact"},{"title":"Get project contact","deprecated":null,"version":null,"openapi":"/openapi.yaml get /projects/{projectId}/contacts/{contactId}","href":"/api-reference/project-contacts/get-project-contact"},{"title":"Update project contact","deprecated":null,"version":null,"openapi":"/openapi.yaml put /projects/{projectId}/contacts/{contactId}","href":"/api-reference/project-contacts/update-project-contact"},{"title":"Delete project contact","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /projects/{projectId}/contacts/{contactId}","href":"/api-reference/project-contacts/delete-project-contact"}]},{"group":"Notes","expanded":false,"pages":[{"title":"List project notes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /projects/{projectId}/notes","href":"/api-reference/project-notes/list-project-notes"},{"title":"Create project note","deprecated":null,"version":null,"openapi":"/openapi.yaml post /projects/{projectId}/notes","href":"/api-reference/project-notes/create-project-note"},{"title":"Get project note","deprecated":null,"version":null,"openapi":"/openapi.yaml get /projects/{projectId}/notes/{noteId}","href":"/api-reference/project-notes/get-project-note"},{"title":"Update project note","deprecated":null,"version":null,"openapi":"/openapi.yaml put /projects/{projectId}/notes/{noteId}","href":"/api-reference/project-notes/update-project-note"},{"title":"Delete project note","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /projects/{projectId}/notes/{noteId}","href":"/api-reference/project-notes/delete-project-note"}]},{"group":"Files","expanded":false,"pages":[{"title":"List project files","deprecated":null,"version":null,"openapi":"/openapi.yaml get /projects/{projectId}/files","href":"/api-reference/project-files/list-project-files"},{"title":"Create project file","deprecated":null,"version":null,"openapi":"/openapi.yaml post /projects/{projectId}/files","href":"/api-reference/project-files/create-project-file"},{"title":"Get project file","deprecated":null,"version":null,"openapi":"/openapi.yaml get /projects/{projectId}/files/{fileId}","href":"/api-reference/project-files/get-project-file"},{"title":"Update project file","deprecated":null,"version":null,"openapi":"/openapi.yaml put /projects/{projectId}/files/{fileId}","href":"/api-reference/project-files/update-project-file"},{"title":"Delete project file","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /projects/{projectId}/files/{fileId}","href":"/api-reference/project-files/delete-project-file"}]},{"group":"Albums","expanded":false,"pages":[{"title":"List project albums","deprecated":null,"version":null,"openapi":"/openapi.yaml get /projects/{projectId}/albums","href":"/api-reference/project-albums/list-project-albums"},{"title":"Create project album","deprecated":null,"version":null,"openapi":"/openapi.yaml post /projects/{projectId}/albums","href":"/api-reference/project-albums/create-project-album"},{"title":"Get project album","deprecated":null,"version":null,"openapi":"/openapi.yaml get /projects/{projectId}/albums/{albumId}","href":"/api-reference/project-albums/get-project-album"},{"title":"Update project album","deprecated":null,"version":null,"openapi":"/openapi.yaml put /projects/{projectId}/albums/{albumId}","href":"/api-reference/project-albums/update-project-album"},{"title":"Delete project album","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /projects/{projectId}/albums/{albumId}","href":"/api-reference/project-albums/delete-project-album"},{"title":"Download project album PDF","deprecated":null,"version":null,"openapi":"/openapi.yaml get /projects/{projectId}/albums/{albumId}/pdf","href":"/api-reference/project-albums/download-project-album-pdf"}]},{"group":"Album Items","expanded":false,"pages":[{"title":"List album items","deprecated":null,"version":null,"openapi":"/openapi.yaml get /projects/{projectId}/albums/{albumId}/items","href":"/api-reference/album-items/list-album-items"},{"title":"Create album item","deprecated":null,"version":null,"openapi":"/openapi.yaml post /projects/{projectId}/albums/{albumId}/items","href":"/api-reference/album-items/create-album-item"},{"title":"Get album item","deprecated":null,"version":null,"openapi":"/openapi.yaml get /projects/{projectId}/albums/{albumId}/items/{itemId}","href":"/api-reference/album-items/get-album-item"},{"title":"Update album item","deprecated":null,"version":null,"openapi":"/openapi.yaml put /projects/{projectId}/albums/{albumId}/items/{itemId}","href":"/api-reference/album-items/update-album-item"},{"title":"Delete album item","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /projects/{projectId}/albums/{albumId}/items/{itemId}","href":"/api-reference/album-items/delete-album-item"}]},{"group":"Custom Fields","expanded":false,"pages":[{"title":"List project custom fields","deprecated":null,"version":null,"openapi":"/openapi.yaml get /projects/{projectId}/custom-fields","href":"/api-reference/project-custom-fields/list-project-custom-fields"},{"title":"Create project custom field","deprecated":null,"version":null,"openapi":"/openapi.yaml post /projects/{projectId}/custom-fields","href":"/api-reference/project-custom-fields/create-project-custom-field"},{"title":"Get project custom field","deprecated":null,"version":null,"openapi":"/openapi.yaml get /projects/{projectId}/custom-fields/{customFieldId}","href":"/api-reference/project-custom-fields/get-project-custom-field"},{"title":"Update project custom field","deprecated":null,"version":null,"openapi":"/openapi.yaml put /projects/{projectId}/custom-fields/{customFieldId}","href":"/api-reference/project-custom-fields/update-project-custom-field"},{"title":"Delete project custom field","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /projects/{projectId}/custom-fields/{customFieldId}","href":"/api-reference/project-custom-fields/delete-project-custom-field"}]},{"group":"Claims","expanded":false,"pages":[{"title":"List project claims","deprecated":null,"version":null,"openapi":"/openapi.yaml get /projects/{projectId}/claims","href":"/api-reference/project-claims/list-project-claims"},{"title":"Get project claim","deprecated":null,"version":null,"openapi":"/openapi.yaml get /projects/{projectId}/claims/{claimId}","href":"/api-reference/project-claims/get-project-claim"}]},{"group":"Permits","expanded":false,"pages":[{"title":"List project permits","deprecated":null,"version":null,"openapi":"/openapi.yaml get /projects/{projectId}/permits","href":"/api-reference/project-permits/list-project-permits"},{"title":"Get project permit","deprecated":null,"version":null,"openapi":"/openapi.yaml get /projects/{projectId}/permits/{permitId}","href":"/api-reference/project-permits/get-project-permit"}]},{"group":"Contracts","expanded":false,"pages":[{"title":"List project contracts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /projects/{projectId}/contracts","href":"/api-reference/project-contracts/list-project-contracts"},{"title":"Get project contract","deprecated":null,"version":null,"openapi":"/openapi.yaml get /projects/{projectId}/contracts/{contractId}","href":"/api-reference/project-contracts/get-project-contract"},{"title":"Download homeowner certificate PDF","deprecated":null,"version":null,"openapi":"/openapi.yaml get /projects/{projectId}/contracts/{contractId}/certificates/hcoc/pdf","href":"/api-reference/project-contracts/download-homeowner-certificate-pdf"},{"title":"Download insurance certificate PDF","deprecated":null,"version":null,"openapi":"/openapi.yaml get /projects/{projectId}/contracts/{contractId}/certificates/icoc/pdf","href":"/api-reference/project-contracts/download-insurance-certificate-pdf"},{"title":"Download job statement PDF","deprecated":null,"version":null,"openapi":"/openapi.yaml get /projects/{projectId}/contracts/{contractId}/statements/job/pdf","href":"/api-reference/project-contracts/download-job-statement-pdf"},{"title":"Download customer statement PDF","deprecated":null,"version":null,"openapi":"/openapi.yaml get /projects/{projectId}/contracts/{contractId}/statements/customer/pdf","href":"/api-reference/project-contracts/download-customer-statement-pdf"}]},{"group":"Contract Invoices","expanded":false,"pages":[{"title":"List contract invoices","deprecated":null,"version":null,"openapi":"/openapi.yaml get /projects/{projectId}/contracts/{contractId}/invoices","href":"/api-reference/contract-invoices/list-contract-invoices"},{"title":"Get contract invoice","deprecated":null,"version":null,"openapi":"/openapi.yaml get /projects/{projectId}/contracts/{contractId}/invoices/{invoiceId}","href":"/api-reference/contract-invoices/get-contract-invoice"},{"title":"Download contract invoice PDF","deprecated":null,"version":null,"openapi":"/openapi.yaml get /projects/{projectId}/contracts/{contractId}/invoices/{invoiceId}/pdf","href":"/api-reference/contract-invoices/download-contract-invoice-pdf"},{"title":"Download contract invoices PDF","deprecated":null,"version":null,"openapi":"/openapi.yaml get /projects/{projectId}/contracts/{contractId}/invoices/pdf","href":"/api-reference/contract-invoices/download-contract-invoices-pdf"}]},{"group":"Work Orders","expanded":false,"pages":[{"title":"List project work orders","deprecated":null,"version":null,"openapi":"/openapi.yaml get /projects/{projectId}/work-orders","href":"/api-reference/work-orders/list-project-work-orders"},{"title":"Get project work order","deprecated":null,"version":null,"openapi":"/openapi.yaml get /projects/{projectId}/work-orders/{workOrderId}","href":"/api-reference/work-orders/get-project-work-order"},{"title":"Update project work order","deprecated":null,"version":null,"openapi":"/openapi.yaml put /projects/{projectId}/work-orders/{workOrderId}","href":"/api-reference/work-orders/update-project-work-order"},{"title":"Download project work order PDF","deprecated":null,"version":null,"openapi":"/openapi.yaml get /projects/{projectId}/work-orders/{workOrderId}/pdf","href":"/api-reference/work-orders/download-project-work-order-pdf"}]},{"group":"Material Orders","expanded":false,"pages":[{"title":"List project material orders","deprecated":null,"version":null,"openapi":"/openapi.yaml get /projects/{projectId}/material-orders","href":"/api-reference/material-orders/list-project-material-orders"},{"title":"Get project material order","deprecated":null,"version":null,"openapi":"/openapi.yaml get /projects/{projectId}/material-orders/{materialOrderId}","href":"/api-reference/material-orders/get-project-material-order"},{"title":"Download project material order PDF","deprecated":null,"version":null,"openapi":"/openapi.yaml get /projects/{projectId}/material-orders/{materialOrderId}/pdf","href":"/api-reference/material-orders/download-project-material-order-pdf"}]}]},{"group":"Accounts","pages":[{"title":"List accounts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /accounts","href":"/api-reference/accounts/list-accounts"},{"title":"Create account","deprecated":null,"version":null,"openapi":"/openapi.yaml post /accounts","href":"/api-reference/accounts/create-account"},{"title":"Get account","deprecated":null,"version":null,"openapi":"/openapi.yaml get /accounts/{accountId}","href":"/api-reference/accounts/get-account"},{"title":"Update account","deprecated":null,"version":null,"openapi":"/openapi.yaml put /accounts/{accountId}","href":"/api-reference/accounts/update-account"},{"title":"Delete account","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /accounts/{accountId}","href":"/api-reference/accounts/delete-account"},{"group":"Contacts","expanded":false,"pages":[{"title":"List account contacts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /accounts/{accountId}/contacts","href":"/api-reference/account-contacts/list-account-contacts"},{"title":"Create account contact","deprecated":null,"version":null,"openapi":"/openapi.yaml post /accounts/{accountId}/contacts","href":"/api-reference/account-contacts/create-account-contact"},{"title":"Get account contact","deprecated":null,"version":null,"openapi":"/openapi.yaml get /accounts/{accountId}/contacts/{contactId}","href":"/api-reference/account-contacts/get-account-contact"},{"title":"Update account contact","deprecated":null,"version":null,"openapi":"/openapi.yaml put /accounts/{accountId}/contacts/{contactId}","href":"/api-reference/account-contacts/update-account-contact"},{"title":"Delete account contact","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /accounts/{accountId}/contacts/{contactId}","href":"/api-reference/account-contacts/delete-account-contact"}]},{"group":"Notes","expanded":false,"pages":[{"title":"List account notes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /accounts/{accountId}/notes","href":"/api-reference/account-notes/list-account-notes"},{"title":"Create account note","deprecated":null,"version":null,"openapi":"/openapi.yaml post /accounts/{accountId}/notes","href":"/api-reference/account-notes/create-account-note"},{"title":"Get account note","deprecated":null,"version":null,"openapi":"/openapi.yaml get /accounts/{accountId}/notes/{noteId}","href":"/api-reference/account-notes/get-account-note"}]}]},{"group":"Contacts","pages":[{"title":"List contacts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /contacts","href":"/api-reference/contacts/list-contacts"},{"title":"Create contact","deprecated":null,"version":null,"openapi":"/openapi.yaml post /contacts","href":"/api-reference/contacts/create-contact"},{"title":"Get contact","deprecated":null,"version":null,"openapi":"/openapi.yaml get /contacts/{contactId}","href":"/api-reference/contacts/get-contact"},{"title":"Update contact","deprecated":null,"version":null,"openapi":"/openapi.yaml put /contacts/{contactId}","href":"/api-reference/contacts/update-contact"},{"title":"Delete contact","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /contacts/{contactId}","href":"/api-reference/contacts/delete-contact"},{"group":"Notes","expanded":false,"pages":[{"title":"List contact notes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /contacts/{contactId}/notes","href":"/api-reference/contact-notes/list-contact-notes"},{"title":"Create contact note","deprecated":null,"version":null,"openapi":"/openapi.yaml post /contacts/{contactId}/notes","href":"/api-reference/contact-notes/create-contact-note"},{"title":"Get contact note","deprecated":null,"version":null,"openapi":"/openapi.yaml get /contacts/{contactId}/notes/{noteId}","href":"/api-reference/contact-notes/get-contact-note"}]}]},{"group":"Leads","pages":[{"title":"List leads","deprecated":null,"version":null,"openapi":"/openapi.yaml get /leads","href":"/api-reference/leads/list-leads"},{"title":"Submit leads","deprecated":null,"version":null,"openapi":"/openapi.yaml post /leads","href":"/api-reference/leads/submit-leads"},{"title":"Delete many leads","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /leads","href":"/api-reference/leads/delete-many-leads"},{"title":"Get lead","deprecated":null,"version":null,"openapi":"/openapi.yaml get /leads/{leadId}","href":"/api-reference/leads/get-lead"},{"title":"Update lead","deprecated":null,"version":null,"openapi":"/openapi.yaml put /leads/{leadId}","href":"/api-reference/leads/update-lead"},{"title":"Delete lead","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /leads/{leadId}","href":"/api-reference/leads/delete-lead"},{"title":"Process lead","deprecated":null,"version":null,"openapi":"/openapi.yaml post /leads/{leadId}/process","href":"/api-reference/leads/process-lead"},{"title":"Convert lead","deprecated":null,"version":null,"openapi":"/openapi.yaml post /leads/{leadId}/convert","href":"/api-reference/leads/convert-lead"},{"group":"Lead Connections","expanded":false,"pages":[{"title":"List lead connections","deprecated":null,"version":null,"openapi":"/openapi.yaml get /lead-connections","href":"/api-reference/lead-connections/list-lead-connections"},{"title":"Create lead connection","deprecated":null,"version":null,"openapi":"/openapi.yaml post /lead-connections","href":"/api-reference/lead-connections/create-lead-connection"},{"title":"Get lead connection","deprecated":null,"version":null,"openapi":"/openapi.yaml get /lead-connections/{leadConnectionId}","href":"/api-reference/lead-connections/get-lead-connection"},{"title":"Update lead connection","deprecated":null,"version":null,"openapi":"/openapi.yaml put /lead-connections/{leadConnectionId}","href":"/api-reference/lead-connections/update-lead-connection"},{"title":"Delete lead connection","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /lead-connections/{leadConnectionId}","href":"/api-reference/lead-connections/delete-lead-connection"},{"title":"List lead connection settings","deprecated":null,"version":null,"openapi":"/openapi.yaml get /lead-connections/{leadConnectionId}/settings","href":"/api-reference/lead-connections/list-lead-connection-settings"},{"title":"Get lead connection setting","deprecated":null,"version":null,"openapi":"/openapi.yaml get /lead-connections/{leadConnectionId}/settings/{key}","href":"/api-reference/lead-connections/get-lead-connection-setting"}]},{"group":"Field Maps","expanded":false,"pages":[{"title":"List field maps","deprecated":null,"version":null,"openapi":"/openapi.yaml get /lead-connections/{leadConnectionId}/field-maps","href":"/api-reference/field-maps/list-field-maps"},{"title":"Create field map","deprecated":null,"version":null,"openapi":"/openapi.yaml post /lead-connections/{leadConnectionId}/field-maps","href":"/api-reference/field-maps/create-field-map"},{"title":"Get field map","deprecated":null,"version":null,"openapi":"/openapi.yaml get /lead-connections/{leadConnectionId}/field-maps/{fieldMapId}","href":"/api-reference/field-maps/get-field-map"},{"title":"Update field map","deprecated":null,"version":null,"openapi":"/openapi.yaml put /lead-connections/{leadConnectionId}/field-maps/{fieldMapId}","href":"/api-reference/field-maps/update-field-map"},{"title":"Delete field map","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /lead-connections/{leadConnectionId}/field-maps/{fieldMapId}","href":"/api-reference/field-maps/delete-field-map"},{"title":"List available target fields","deprecated":null,"version":null,"openapi":"/openapi.yaml get /lead-connections/{leadConnectionId}/field-maps/available","href":"/api-reference/field-maps/list-available-target-fields"},{"title":"Generate field maps","deprecated":null,"version":null,"openapi":"/openapi.yaml post /lead-connections/{leadConnectionId}/field-maps/generate","href":"/api-reference/field-maps/generate-field-maps"}]},{"group":"Rep Assignments","expanded":false,"pages":[{"title":"List rep assignments","deprecated":null,"version":null,"openapi":"/openapi.yaml get /lead-connections/{leadConnectionId}/rep-assignments","href":"/api-reference/rep-assignments/list-rep-assignments"},{"title":"Create rep assignment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /lead-connections/{leadConnectionId}/rep-assignments","href":"/api-reference/rep-assignments/create-rep-assignment"},{"title":"Get rep assignment","deprecated":null,"version":null,"openapi":"/openapi.yaml get /lead-connections/{leadConnectionId}/rep-assignments/{repAssignmentId}","href":"/api-reference/rep-assignments/get-rep-assignment"},{"title":"Delete rep assignment","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /lead-connections/{leadConnectionId}/rep-assignments/{repAssignmentId}","href":"/api-reference/rep-assignments/delete-rep-assignment"}]}]},{"group":"Companies","pages":[{"title":"List companies","deprecated":null,"version":null,"openapi":"/openapi.yaml get /companies","href":"/api-reference/companies/list-companies"},{"title":"Get company","deprecated":null,"version":null,"openapi":"/openapi.yaml get /companies/{companyId}","href":"/api-reference/companies/get-company"},{"group":"Appointment Types","expanded":false,"pages":[{"title":"List company appointment types","deprecated":null,"version":null,"openapi":"/openapi.yaml get /companies/{companyId}/appointment-types","href":"/api-reference/company-appointment-types/list-company-appointment-types"},{"title":"Get company appointment type","deprecated":null,"version":null,"openapi":"/openapi.yaml get /companies/{companyId}/appointment-types/{appointmentTypeId}","href":"/api-reference/company-appointment-types/get-company-appointment-type"}]},{"group":"Custom Fields","expanded":false,"pages":[{"title":"List company custom fields","deprecated":null,"version":null,"openapi":"/openapi.yaml get /companies/{companyId}/custom-fields","href":"/api-reference/company-custom-fields/list-company-custom-fields"},{"title":"Get company custom field","deprecated":null,"version":null,"openapi":"/openapi.yaml get /companies/{companyId}/custom-fields/{customFieldId}","href":"/api-reference/company-custom-fields/get-company-custom-field"}]},{"group":"Events","expanded":false,"pages":[{"title":"List events","deprecated":null,"version":null,"openapi":"/openapi.yaml get /companies/{companyId}/events","href":"/api-reference/events/list-events"},{"title":"Get event","deprecated":null,"version":null,"openapi":"/openapi.yaml get /companies/{companyId}/events/{eventId}","href":"/api-reference/events/get-event"}]},{"group":"Lead Sources","expanded":false,"pages":[{"title":"List lead sources","deprecated":null,"version":null,"openapi":"/openapi.yaml get /companies/{companyId}/leads","href":"/api-reference/lead-sources/list-lead-sources"},{"title":"Get lead source","deprecated":null,"version":null,"openapi":"/openapi.yaml get /companies/{companyId}/leads/{leadSourceId}","href":"/api-reference/lead-sources/get-lead-source"}]},{"group":"Milestones","expanded":false,"pages":[{"title":"List milestones","deprecated":null,"version":null,"openapi":"/openapi.yaml get /companies/{companyId}/milestones","href":"/api-reference/milestones/list-milestones"},{"title":"Get milestone","deprecated":null,"version":null,"openapi":"/openapi.yaml get /companies/{companyId}/milestones/{milestoneId}","href":"/api-reference/milestones/get-milestone"}]},{"group":"Roles","expanded":false,"pages":[{"title":"List company roles","deprecated":null,"version":null,"openapi":"/openapi.yaml get /companies/{companyId}/company-roles","href":"/api-reference/company-roles/list-company-roles"},{"title":"Get company role","deprecated":null,"version":null,"openapi":"/openapi.yaml get /companies/{companyId}/company-roles/{companyRoleId}","href":"/api-reference/company-roles/get-company-role"}]},{"group":"Workflows","expanded":false,"pages":[{"title":"List workflows","deprecated":null,"version":null,"openapi":"/openapi.yaml get /companies/{companyId}/workflows","href":"/api-reference/workflows/list-workflows"},{"title":"Get workflow","deprecated":null,"version":null,"openapi":"/openapi.yaml get /companies/{companyId}/workflows/{workflowId}","href":"/api-reference/workflows/get-workflow"}]}]},{"group":"Users","pages":[{"title":"List users","deprecated":null,"version":null,"openapi":"/openapi.yaml get /users","href":"/api-reference/users/list-users"},{"title":"Get user","deprecated":null,"version":null,"openapi":"/openapi.yaml get /users/{userId}","href":"/api-reference/users/get-user"}]},{"group":"Teams","pages":[{"title":"List teams","deprecated":null,"version":null,"openapi":"/openapi.yaml get /teams","href":"/api-reference/teams/list-teams"},{"title":"Create team","deprecated":null,"version":null,"openapi":"/openapi.yaml post /teams","href":"/api-reference/teams/create-team"},{"title":"Get team","deprecated":null,"version":null,"openapi":"/openapi.yaml get /teams/{teamId}","href":"/api-reference/teams/get-team"},{"title":"Update team","deprecated":null,"version":null,"openapi":"/openapi.yaml put /teams/{teamId}","href":"/api-reference/teams/update-team"},{"group":"Team Members","expanded":false,"pages":[{"title":"List team members","deprecated":null,"version":null,"openapi":"/openapi.yaml get /teams/{teamId}/team-members","href":"/api-reference/team-members/list-team-members"},{"title":"Create team member","deprecated":null,"version":null,"openapi":"/openapi.yaml post /teams/{teamId}/team-members","href":"/api-reference/team-members/create-team-member"},{"title":"Get team member","deprecated":null,"version":null,"openapi":"/openapi.yaml get /teams/{teamId}/team-members/{teamMemberId}","href":"/api-reference/team-members/get-team-member"},{"title":"Update team member","deprecated":null,"version":null,"openapi":"/openapi.yaml put /teams/{teamId}/team-members/{teamMemberId}","href":"/api-reference/team-members/update-team-member"},{"title":"Delete team member","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /teams/{teamId}/team-members/{teamMemberId}","href":"/api-reference/team-members/delete-team-member"}]},{"group":"Team Companies","expanded":false,"pages":[{"title":"List team companies","deprecated":null,"version":null,"openapi":"/openapi.yaml get /teams/{teamId}/team-companies","href":"/api-reference/team-companies/list-team-companies"},{"title":"Create team company","deprecated":null,"version":null,"openapi":"/openapi.yaml post /teams/{teamId}/team-companies","href":"/api-reference/team-companies/create-team-company"},{"title":"Get team company","deprecated":null,"version":null,"openapi":"/openapi.yaml get /teams/{teamId}/team-companies/{teamCompanyId}","href":"/api-reference/team-companies/get-team-company"},{"title":"Delete team company","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /teams/{teamId}/team-companies/{teamCompanyId}","href":"/api-reference/team-companies/delete-team-company"}]},{"group":"Team Notes","expanded":false,"pages":[{"title":"List team notes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /teams/{teamId}/team-notes","href":"/api-reference/team-notes/list-team-notes"},{"title":"Get team note","deprecated":null,"version":null,"openapi":"/openapi.yaml get /teams/{teamId}/team-notes/{teamNoteId}","href":"/api-reference/team-notes/get-team-note"}]}]},{"group":"Appointments","pages":[{"title":"List appointments","deprecated":null,"version":null,"openapi":"/openapi.yaml get /appointments","href":"/api-reference/appointments/list-appointments"},{"title":"Create appointment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /appointments","href":"/api-reference/appointments/create-appointment"},{"title":"Get appointment","deprecated":null,"version":null,"openapi":"/openapi.yaml get /appointments/{appointmentId}","href":"/api-reference/appointments/get-appointment"},{"title":"Update appointment","deprecated":null,"version":null,"openapi":"/openapi.yaml put /appointments/{appointmentId}","href":"/api-reference/appointments/update-appointment"},{"title":"Delete appointment","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /appointments/{appointmentId}","href":"/api-reference/appointments/delete-appointment"},{"title":"Get calendar feed address","deprecated":null,"version":null,"openapi":"/openapi.yaml get /appointments/ical","href":"/api-reference/appointments/get-calendar-feed-address"},{"title":"Download calendar feed","deprecated":null,"version":null,"openapi":"/openapi.yaml get /appointments/ics","href":"/api-reference/appointments/download-calendar-feed"},{"group":"Attendees","expanded":false,"pages":[{"title":"List attendees","deprecated":null,"version":null,"openapi":"/openapi.yaml get /appointments/{appointmentId}/attendees","href":"/api-reference/appointment-attendees/list-attendees"},{"title":"Create attendee","deprecated":null,"version":null,"openapi":"/openapi.yaml post /appointments/{appointmentId}/attendees","href":"/api-reference/appointment-attendees/create-attendee"},{"title":"Get attendee","deprecated":null,"version":null,"openapi":"/openapi.yaml get /appointments/{appointmentId}/attendees/{attendeeId}","href":"/api-reference/appointment-attendees/get-attendee"},{"title":"Update attendee","deprecated":null,"version":null,"openapi":"/openapi.yaml put /appointments/{appointmentId}/attendees/{attendeeId}","href":"/api-reference/appointment-attendees/update-attendee"},{"title":"Delete attendee","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /appointments/{appointmentId}/attendees/{attendeeId}","href":"/api-reference/appointment-attendees/delete-attendee"}]}]},{"group":"Tasks","pages":[{"title":"List tasks","deprecated":null,"version":null,"openapi":"/openapi.yaml get /tasks","href":"/api-reference/tasks/list-tasks"},{"title":"Create task","deprecated":null,"version":null,"openapi":"/openapi.yaml post /tasks","href":"/api-reference/tasks/create-task"},{"title":"Get task","deprecated":null,"version":null,"openapi":"/openapi.yaml get /tasks/{taskId}","href":"/api-reference/tasks/get-task"},{"title":"Update task","deprecated":null,"version":null,"openapi":"/openapi.yaml put /tasks/{taskId}","href":"/api-reference/tasks/update-task"},{"title":"Delete task","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /tasks/{taskId}","href":"/api-reference/tasks/delete-task"},{"group":"Notes","expanded":false,"pages":[{"title":"List task notes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /tasks/{taskId}/notes","href":"/api-reference/task-notes/list-task-notes"},{"title":"Create task note","deprecated":null,"version":null,"openapi":"/openapi.yaml post /tasks/{taskId}/notes","href":"/api-reference/task-notes/create-task-note"},{"title":"Get task note","deprecated":null,"version":null,"openapi":"/openapi.yaml get /tasks/{taskId}/notes/{noteId}","href":"/api-reference/task-notes/get-task-note"},{"title":"Update task note","deprecated":null,"version":null,"openapi":"/openapi.yaml put /tasks/{taskId}/notes/{noteId}","href":"/api-reference/task-notes/update-task-note"},{"title":"Delete task note","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /tasks/{taskId}/notes/{noteId}","href":"/api-reference/task-notes/delete-task-note"}]}]},{"group":"Jet Streams","pages":[{"title":"List jet streams","deprecated":null,"version":null,"openapi":"/openapi.yaml get /jet-streams","href":"/api-reference/jet-streams/list-jet-streams"},{"title":"Create jet stream","deprecated":null,"version":null,"openapi":"/openapi.yaml post /jet-streams","href":"/api-reference/jet-streams/create-jet-stream"},{"title":"Get jet stream","deprecated":null,"version":null,"openapi":"/openapi.yaml get /jet-streams/{jetStreamId}","href":"/api-reference/jet-streams/get-jet-stream"},{"title":"Update jet stream","deprecated":null,"version":null,"openapi":"/openapi.yaml put /jet-streams/{jetStreamId}","href":"/api-reference/jet-streams/update-jet-stream"},{"title":"Delete jet stream","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /jet-streams/{jetStreamId}","href":"/api-reference/jet-streams/delete-jet-stream"},{"title":"Mark jet streams read","deprecated":null,"version":null,"openapi":"/openapi.yaml post /jet-streams/mark-read","href":"/api-reference/jet-streams/mark-jet-streams-read"},{"title":"Mark jet stream read","deprecated":null,"version":null,"openapi":"/openapi.yaml post /jet-streams/{jetStreamId}/mark-read","href":"/api-reference/jet-streams/mark-jet-stream-read"},{"group":"Jet Stream Users","expanded":false,"pages":[{"title":"List jet stream users","deprecated":null,"version":null,"openapi":"/openapi.yaml get /jet-streams/{jetStreamId}/users","href":"/api-reference/jet-stream-users/list-jet-stream-users"},{"title":"Create jet stream user","deprecated":null,"version":null,"openapi":"/openapi.yaml post /jet-streams/{jetStreamId}/users","href":"/api-reference/jet-stream-users/create-jet-stream-user"},{"title":"Get jet stream user","deprecated":null,"version":null,"openapi":"/openapi.yaml get /jet-streams/{jetStreamId}/users/{jetStreamUserId}","href":"/api-reference/jet-stream-users/get-jet-stream-user"},{"title":"Update jet stream user","deprecated":null,"version":null,"openapi":"/openapi.yaml put /jet-streams/{jetStreamId}/users/{jetStreamUserId}","href":"/api-reference/jet-stream-users/update-jet-stream-user"},{"title":"Delete jet stream user","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /jet-streams/{jetStreamId}/users/{jetStreamUserId}","href":"/api-reference/jet-stream-users/delete-jet-stream-user"}]},{"group":"Jet Stream Replies","expanded":false,"pages":[{"title":"List jet stream replies","deprecated":null,"version":null,"openapi":"/openapi.yaml get /jet-streams/{jetStreamId}/replies","href":"/api-reference/jet-stream-replies/list-jet-stream-replies"},{"title":"Create jet stream reply","deprecated":null,"version":null,"openapi":"/openapi.yaml post /jet-streams/{jetStreamId}/replies","href":"/api-reference/jet-stream-replies/create-jet-stream-reply"},{"title":"Get jet stream reply","deprecated":null,"version":null,"openapi":"/openapi.yaml get /jet-streams/{jetStreamId}/replies/{jetStreamReplyId}","href":"/api-reference/jet-stream-replies/get-jet-stream-reply"},{"title":"Update jet stream reply","deprecated":null,"version":null,"openapi":"/openapi.yaml put /jet-streams/{jetStreamId}/replies/{jetStreamReplyId}","href":"/api-reference/jet-stream-replies/update-jet-stream-reply"},{"title":"Delete jet stream reply","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /jet-streams/{jetStreamId}/replies/{jetStreamReplyId}","href":"/api-reference/jet-stream-replies/delete-jet-stream-reply"}]}]},{"group":"Suppliers","pages":[{"title":"List suppliers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /suppliers","href":"/api-reference/suppliers/list-suppliers"},{"title":"Get supplier","deprecated":null,"version":null,"openapi":"/openapi.yaml get /suppliers/{supplierId}","href":"/api-reference/suppliers/get-supplier"}]},{"group":"Crews","pages":[{"title":"List crews","deprecated":null,"version":null,"openapi":"/openapi.yaml get /crews","href":"/api-reference/crews/list-crews"},{"title":"Get crew","deprecated":null,"version":null,"openapi":"/openapi.yaml get /crews/{crewId}","href":"/api-reference/crews/get-crew"}]},{"group":"Webhooks","pages":[{"title":"List webhooks","deprecated":null,"version":null,"openapi":"/openapi.yaml get /webhooks","href":"/api-reference/webhooks/list-webhooks"},{"title":"Create webhook","deprecated":null,"version":null,"openapi":"/openapi.yaml post /webhooks","href":"/api-reference/webhooks/create-webhook"},{"title":"Get webhook","deprecated":null,"version":null,"openapi":"/openapi.yaml get /webhooks/{webhookId}","href":"/api-reference/webhooks/get-webhook"},{"title":"Update webhook","deprecated":null,"version":null,"openapi":"/openapi.yaml put /webhooks/{webhookId}","href":"/api-reference/webhooks/update-webhook"},{"title":"Delete webhook","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /webhooks/{webhookId}","href":"/api-reference/webhooks/delete-webhook"},{"title":"List subscribable events","deprecated":null,"version":null,"openapi":"/openapi.yaml get /webhooks/subscribable-events","href":"/api-reference/webhooks/list-subscribable-events"},{"group":"Events","expanded":false,"pages":[{"title":"List webhook events","deprecated":null,"version":null,"openapi":"/openapi.yaml get /webhooks/{webhookId}/events","href":"/api-reference/webhook-events/list-webhook-events"},{"title":"Create webhook event","deprecated":null,"version":null,"openapi":"/openapi.yaml post /webhooks/{webhookId}/events","href":"/api-reference/webhook-events/create-webhook-event"},{"title":"Get webhook event","deprecated":null,"version":null,"openapi":"/openapi.yaml get /webhooks/{webhookId}/events/{eventId}","href":"/api-reference/webhook-events/get-webhook-event"},{"title":"Update webhook event","deprecated":null,"version":null,"openapi":"/openapi.yaml put /webhooks/{webhookId}/events/{eventId}","href":"/api-reference/webhook-events/update-webhook-event"},{"title":"Delete webhook event","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /webhooks/{webhookId}/events/{eventId}","href":"/api-reference/webhook-events/delete-webhook-event"}]},{"group":"Sends","expanded":false,"pages":[{"title":"List webhook sends","deprecated":null,"version":null,"openapi":"/openapi.yaml get /webhooks/{webhookId}/sends","href":"/api-reference/webhook-sends/list-webhook-sends"},{"title":"Send test webhook","deprecated":null,"version":null,"openapi":"/openapi.yaml post /webhooks/{webhookId}/sends","href":"/api-reference/webhook-sends/send-test-webhook"},{"title":"Get webhook send","deprecated":null,"version":null,"openapi":"/openapi.yaml get /webhooks/{webhookId}/sends/{sendId}","href":"/api-reference/webhook-sends/get-webhook-send"}]}]},{"group":"Search","pages":[{"title":"Search","description":"Searches across multiple resource types in a single request. Ideal for powering a global search box that surfaces matching projects, contacts, accounts, and more in one call.\n\n### Request format\n\nThe request body is an object whose keys name the resource types to search — supported keys are `users`, `projects`, `contacts`, `accounts`, and `claims`. Each key's value is an object of query parameters for that resource type, using the same `filter`, `sort`, `include`, and `page` parameters accepted by that resource's own list endpoint — for example, `{\"contacts\": {\"filter\": {\"search\": \"smith\"}}}` runs the equivalent of `filter[search]=smith` against contacts. Passing a `filter`, `sort`, or `include` value that resource doesn't allow returns a `400` response naming the allowed values for that resource, the same as calling that resource's own list endpoint directly.\n\n### Results\n\nResults are grouped by resource type in the order the keys appear in the request, and a resource type with no matches is omitted from the response entirely. Each group returns up to `page.size` results for that resource (default 5, maximum 30, even if a higher value is given). This endpoint doesn't return pagination totals or page counts for any group — use the resource's own list endpoint if you need full pagination.\n\n### How matching works\n\nFor `filter.search`, every space-separated word in the value must match somewhere in the searched fields as a substring.\n\n- **projects** — matches against the project's key details, including the project's name and address, its linked account's name, and the names of any contacts linked to the project or its account.\n- **contacts** — matches against the contact's key details, including first name, last name, and email.\n- **users** — matches the same fields as `filter[search]` on [List users](/api-reference/users/list-users).\n- **accounts** — matches the same fields as `filter[search]` on [List accounts](/api-reference/accounts/list-accounts).\n- **claims** — matches a claim's policy number, claim number, and comment.","deprecated":null,"version":null,"openapi":"/openapi.yaml post /search","href":"/api-reference/search/search"}]},{"group":"Meta","pages":[{"title":"List available options","deprecated":null,"version":null,"openapi":"/openapi.yaml get /meta/available-options/{type}","href":"/api-reference/meta/list-available-options"},{"title":"Get API status","description":"Returns the current operational status and version of the Contractors Cloud API. No authentication is required, making this the simplest way to confirm you can reach the API before wiring up a token — pair it with [Get user](/api-reference/users/get-user) using `me` to then verify your token works. Send the `Accept: application/json` header — without it, this endpoint returns an HTML page instead of a JSON response.","deprecated":null,"version":null,"openapi":"/openapi.yaml get /meta/status","href":"/api-reference/meta/get-api-status"}]}]}]},{"tab":"Guides","icon":"compass","pages":[{"title":"Guides","href":"/guides/webhooks"}]},{"tab":"Types","icon":"brackets-curly","pages":[{"title":"Types","href":"/types/overview"}]}]},"title":"List available options - Contractors Cloud API","buildId":"dpl_BvXubCjoPYfvfFiCP5WgKvGYUZ9k","deploymentId":"dpl_BvXubCjoPYfvfFiCP5WgKvGYUZ9k","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Cn24bQ-L.js","utils-2fswSlDf.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CCIi4ABW.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CAH7N_Ow.js","snippetPresets-x_0VpYAk.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-llGafAZf.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-W1eCShSz.js","shallow-NLT_NnDI.js","getApiPlaygroundDisplay-QSEhtcdZ.js","CodeSnippet-CK8Lk0kg.js","CodeSnippets-Cra_whAm.js","Page-CQfXSH2v.js","getPastedJson-BEz4UfPL.js","icon-CwvrEduL.js","MethodPill-DblyOGAG.js","DuplicateIcon-7P7ixz4I.js","createIcon-BURR5_pt.js","DynamicMarkdown-DteaQut7.js","SectionHeading-CHtmkzk7.js","axios-vUo_bRtp.js","Markdown-BIU4AXHQ.js","clsx-Ds0AvV0Z.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Ka3QKbKd.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BURaoZsB.js"]}