Authenticate with an API access token in the Authorization header: Authorization: Bearer <token>. Create a token from the API Access Tokens page in Contractors Cloud, under Integrations.
Filters by an extended property's key and value, using the syntax filter[extended_property][<key>]=<value>. Matches users with an extended property whose key equals <key> and whose value exactly equals <value> (comma-separate multiple values to match any of them).
The id of the user's permission level (role), which determines the pages, reports, and actions the user can access. Can be null if no level has been assigned.
{"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/users/list-users","slug":"/api-reference/users/list-users","pageMetadata":{"title":"List users","description":"Returns a paginated list of users in your organization. Use filters, sorts, includes, and appends to shape the result set.","deprecated":null,"version":null,"openapi":"/openapi.yaml get /users","href":"/api-reference/users/list-users","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Returns a paginated list of users in your organization. Use filters, sorts, includes, and appends to shape the result set.\"\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 users","description":"Returns a paginated list of users in your organization. Use filters, sorts, includes, and appends to shape the result set.","deprecated":null,"version":null,"openapi":"/openapi.yaml get /users","href":"/api-reference/users/list-users","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"listUsers","summary":"List users","description":"Returns a paginated list of users in your organization. Use filters, sorts, includes, and appends to shape the result set.","tags":["Users"],"parameters":["7494b599-73c7-40c4-9997-8b34e8e2f2cc","8fe1c011-a5fd-45d1-b941-beab899454f0","77277649-e12f-498b-a544-dcedfe427d9f","83608a00-9efc-42c7-897f-15e4e147391f","c37f4411-1cd4-44ae-938c-0cec389a36f5","a4f6128d-f418-47f4-bd2c-38caefdf778b","19ddcc23-c4da-405e-b240-cb780c6388d5","4bd37143-0100-41ee-9753-d1541beb679d","b077c05b-ed49-4979-910d-07cdeb3b4894","c3b8731b-4738-4158-8cc8-6fa87e74000b","31b1004d-b6b7-467d-ba50-6379b1b953f6","6c18d105-315a-4ada-9dda-de6ceeb04655"],"responses":{"200":"10dbe6e6-85a4-43f0-a26c-af5dd7d8d355","401":"dbdb49d3-b452-4124-97db-9909079f49db"},"method":"get","type":"path","servers":["d40a5874-0065-43ae-a49c-61cdcc45656d"],"security":["739ac8a3-46c9-4712-800c-cf69cb68725f"],"path":"/users","baseUrlOptions":["https://api.contractorscloud.com/api/v1"],"title":"List users","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"7494b599-73c7-40c4-9997-8b34e8e2f2cc":{"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"}},"8fe1c011-a5fd-45d1-b941-beab899454f0":{"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"}},"77277649-e12f-498b-a544-dcedfe427d9f":{"name":"filter[id]","in":"query","description":"Exact match on the user's id.","schema":{"type":"integer","description":"Exact match on the user's id.","uniqueKey":"","typeLabel":"integer"}},"83608a00-9efc-42c7-897f-15e4e147391f":{"name":"filter[email]","in":"query","description":"Exact match on the user's email address.","schema":{"type":"string","description":"Exact match on the user's email address.","uniqueKey":"","typeLabel":"string"}},"c37f4411-1cd4-44ae-938c-0cec389a36f5":{"name":"filter[status]","in":"query","description":"Exact match on the user's active status (`1` or `0`).","schema":{"type":"boolean","description":"Exact match on the user's active status (`1` or `0`).","uniqueKey":"","typeLabel":"boolean"}},"a4f6128d-f418-47f4-bd2c-38caefdf778b":{"name":"filter[search]","in":"query","description":"Fuzzy search across first name, last name, email, and username.","schema":{"type":"string","description":"Fuzzy search across first name, last name, email, and username.","uniqueKey":"","typeLabel":"string"}},"19ddcc23-c4da-405e-b240-cb780c6388d5":{"name":"filter[employed]","in":"query","description":"Limit to currently employed (`1`) or terminated (`0`) users.","schema":{"type":"boolean","description":"Limit to currently employed (`1`) or terminated (`0`) users.","uniqueKey":"","typeLabel":"boolean"}},"4bd37143-0100-41ee-9753-d1541beb679d":{"name":"filter[in_company]","in":"query","description":"Limit to users assigned to the given company id.","schema":{"type":"integer","description":"Limit to users assigned to the given company id.","uniqueKey":"","typeLabel":"integer"}},"b077c05b-ed49-4979-910d-07cdeb3b4894":{"name":"filter[extended_property]","in":"query","style":"deepObject","explode":true,"description":"Filters by an extended property's key and value, using the syntax `filter[extended_property][\u003ckey>]=\u003cvalue>`. Matches users with an extended property whose key equals `\u003ckey>` and whose value exactly equals `\u003cvalue>` (comma-separate multiple values to match any of them).","schema":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"additionalProperties","typeLabel":"string"},"description":"Filters by an extended property's key and value, using the syntax `filter[extended_property][\u003ckey>]=\u003cvalue>`. Matches users with an extended property whose key equals `\u003ckey>` and whose value exactly equals `\u003cvalue>` (comma-separate multiple values to match any of them).","uniqueKey":"","typeLabel":"object"},"example":{"badge_number":"BADGE-1042"}},"c3b8731b-4738-4158-8cc8-6fa87e74000b":{"name":"include","in":"query","description":"Comma-separated related resources to embed. Allowed: `user_level`, `default_company`, `project_list_setting`, `extended_properties`.","schema":{"type":"string","description":"Comma-separated related resources to embed. Allowed: `user_level`, `default_company`, `project_list_setting`, `extended_properties`.","uniqueKey":"","typeLabel":"string"},"example":"user_level,default_company"},"31b1004d-b6b7-467d-ba50-6379b1b953f6":{"name":"append","in":"query","description":"Comma-separated computed attributes to include. Allowed: `home_page`, `project_page`, `is_password_set`, `needs_onboarding`, `two_factor_setup_status`.","schema":{"type":"string","description":"Comma-separated computed attributes to include. Allowed: `home_page`, `project_page`, `is_password_set`, `needs_onboarding`, `two_factor_setup_status`.","uniqueKey":"","typeLabel":"string"}},"6c18d105-315a-4ada-9dda-de6ceeb04655":{"name":"sort","in":"query","description":"Field to sort by. Prefix with `-` for descending. Allowed: `first_name`, `last_name`, `email`, `status`.","schema":{"type":"string","description":"Field to sort by. Prefix with `-` for descending. Allowed: `first_name`, `last_name`, `email`, `status`.","uniqueKey":"","typeLabel":"string"},"example":"last_name"}},"responses":{"10dbe6e6-85a4-43f0-a26c-af5dd7d8d355":{"description":"A paginated list of users.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"The user's unique identifier.","example":1159,"uniqueKey":"data.items.[INDEX].id","typeLabel":"integer"},"tenant_id":{"type":"integer","description":"The id of your organization's account.","example":1,"uniqueKey":"data.items.[INDEX].tenant_id","typeLabel":"integer"},"default_company_id":{"type":"integer","description":"The id of the company selected as this user's default company. References a company in your organization.","example":6,"uniqueKey":"data.items.[INDEX].default_company_id","typeLabel":"integer"},"user_level_id":{"oneOf":[{"type":"integer","description":"The id of the user's permission level (role), which determines the pages, reports, and actions the user can access. Can be null if no level has been assigned.","example":4,"uniqueKey":"data.items.[INDEX].user_level_id.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The id of the user's permission level (role), which determines the pages, reports, and actions the user can access. Can be null if no level has been assigned.","example":4,"uniqueKey":"data.items.[INDEX].user_level_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].user_level_id","typeLabel":"integer | null"},"email":{"oneOf":[{"type":"string","description":"The user's email address, used to log in. Kept in sync with `username` — the two are always identical.","example":"jane.doe@example.com","uniqueKey":"data.items.[INDEX].email.oneOf.0","typeLabel":"string"},{"type":"null","description":"The user's email address, used to log in. Kept in sync with `username` — the two are always identical.","example":"jane.doe@example.com","uniqueKey":"data.items.[INDEX].email.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].email","typeLabel":"string | null"},"username":{"type":"string","description":"The user's login username. Kept in sync with `email` — the two are always identical.","example":"jane.doe@example.com","uniqueKey":"data.items.[INDEX].username","typeLabel":"string"},"first_name":{"type":"string","description":"The user's first name.","example":"Jane","uniqueKey":"data.items.[INDEX].first_name","typeLabel":"string"},"last_name":{"oneOf":[{"type":"string","description":"The user's last name. Can be null for legacy user records.","example":"Doe","uniqueKey":"data.items.[INDEX].last_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The user's last name. Can be null for legacy user records.","example":"Doe","uniqueKey":"data.items.[INDEX].last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].last_name","typeLabel":"string | null"},"initials":{"oneOf":[{"type":"string","description":"The user's initials, typically derived from their first and last name. Can be null if not set.","example":"JD","uniqueKey":"data.items.[INDEX].initials.oneOf.0","typeLabel":"string"},{"type":"null","description":"The user's initials, typically derived from their first and last name. Can be null if not set.","example":"JD","uniqueKey":"data.items.[INDEX].initials.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].initials","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","description":"The user's job title within your organization. Can be null if not set.","example":"Operations Manager","uniqueKey":"data.items.[INDEX].title.oneOf.0","typeLabel":"string"},{"type":"null","description":"The user's job title within your organization. Can be null if not set.","example":"Operations Manager","uniqueKey":"data.items.[INDEX].title.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].title","typeLabel":"string | null"},"color":{"oneOf":[{"type":"string","description":"Hex color code used to visually represent the user throughout the app, for example on calendar and schedule views. Can be null if not set.","example":"#0a7d2c","uniqueKey":"data.items.[INDEX].color.oneOf.0","typeLabel":"string"},{"type":"null","description":"Hex color code used to visually represent the user throughout the app, for example on calendar and schedule views. Can be null if not set.","example":"#0a7d2c","uniqueKey":"data.items.[INDEX].color.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].color","typeLabel":"string | null"},"timezone":{"oneOf":[{"type":"string","description":"The IANA time zone identifier (for example `America/Chicago`) used to display dates and times for this user. Can be null if not set.","example":"America/Chicago","uniqueKey":"data.items.[INDEX].timezone.oneOf.0","typeLabel":"string"},{"type":"null","description":"The IANA time zone identifier (for example `America/Chicago`) used to display dates and times for this user. Can be null if not set.","example":"America/Chicago","uniqueKey":"data.items.[INDEX].timezone.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].timezone","typeLabel":"string | null"},"started_at":{"oneOf":[{"type":"string","format":"date","description":"The date the user started with your organization, formatted as `YYYY-MM-DD`. Can be null if not recorded.","example":"2019-06-03","uniqueKey":"data.items.[INDEX].started_at.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"The date the user started with your organization, formatted as `YYYY-MM-DD`. Can be null if not recorded.","example":"2019-06-03","uniqueKey":"data.items.[INDEX].started_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].started_at","typeLabel":"string\u003cdate> | null"},"terminated_at":{"oneOf":[{"type":"string","format":"date","description":"The date the user was terminated, formatted as `YYYY-MM-DD`. Null while the user remains active.","example":null,"uniqueKey":"data.items.[INDEX].terminated_at.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"The date the user was terminated, formatted as `YYYY-MM-DD`. Null while the user remains active.","example":null,"uniqueKey":"data.items.[INDEX].terminated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].terminated_at","typeLabel":"string\u003cdate> | null"},"is_active":{"type":"boolean","description":"Whether the user's account is active. Inactive users cannot authenticate.","example":true,"uniqueKey":"data.items.[INDEX].is_active","typeLabel":"boolean"},"phone_home":{"oneOf":[{"type":"string","description":"The user's home phone number. Null if not provided.","uniqueKey":"data.items.[INDEX].phone_home.oneOf.0","typeLabel":"string"},{"type":"null","description":"The user's home phone number. Null if not provided.","uniqueKey":"data.items.[INDEX].phone_home.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].phone_home","typeLabel":"string | null"},"phone_cell":{"oneOf":[{"type":"string","description":"The user's cell phone number. Null if not provided.","example":"(555) 100-2048","uniqueKey":"data.items.[INDEX].phone_cell.oneOf.0","typeLabel":"string"},{"type":"null","description":"The user's cell phone number. Null if not provided.","example":"(555) 100-2048","uniqueKey":"data.items.[INDEX].phone_cell.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].phone_cell","typeLabel":"string | null"},"phone_direct":{"oneOf":[{"type":"string","description":"The user's direct work phone number. Null if not provided.","uniqueKey":"data.items.[INDEX].phone_direct.oneOf.0","typeLabel":"string"},{"type":"null","description":"The user's direct work phone number. Null if not provided.","uniqueKey":"data.items.[INDEX].phone_direct.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].phone_direct","typeLabel":"string | null"},"phone_direct_ext":{"oneOf":[{"type":"string","description":"Extension for the user's direct phone number. Null if not applicable.","uniqueKey":"data.items.[INDEX].phone_direct_ext.oneOf.0","typeLabel":"string"},{"type":"null","description":"Extension for the user's direct phone number. Null if not applicable.","uniqueKey":"data.items.[INDEX].phone_direct_ext.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].phone_direct_ext","typeLabel":"string | null"},"address_street":{"oneOf":[{"type":"string","description":"The street portion of the user's address. Null if not provided.","uniqueKey":"data.items.[INDEX].address_street.oneOf.0","typeLabel":"string"},{"type":"null","description":"The street portion of the user's address. Null if not provided.","uniqueKey":"data.items.[INDEX].address_street.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].address_street","typeLabel":"string | null"},"address_city":{"oneOf":[{"type":"string","description":"The city portion of the user's address. Null if not provided.","uniqueKey":"data.items.[INDEX].address_city.oneOf.0","typeLabel":"string"},{"type":"null","description":"The city portion of the user's address. Null if not provided.","uniqueKey":"data.items.[INDEX].address_city.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].address_city","typeLabel":"string | null"},"address_state":{"oneOf":[{"type":"string","description":"The two-letter state or province code for the user's address. Can be null if not provided.","example":"WI","uniqueKey":"data.items.[INDEX].address_state.oneOf.0","typeLabel":"string"},{"type":"null","description":"The two-letter state or province code for the user's address. Can be null if not provided.","example":"WI","uniqueKey":"data.items.[INDEX].address_state.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].address_state","typeLabel":"string | null"},"address_zip":{"oneOf":[{"type":"string","description":"The postal code for the user's address. Null if not provided.","uniqueKey":"data.items.[INDEX].address_zip.oneOf.0","typeLabel":"string"},{"type":"null","description":"The postal code for the user's address. Null if not provided.","uniqueKey":"data.items.[INDEX].address_zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].address_zip","typeLabel":"string | null"},"tax_id":{"oneOf":[{"type":"string","description":"The user's tax identification number, used for subcontractor reporting. Null if not provided.","uniqueKey":"data.items.[INDEX].tax_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The user's tax identification number, used for subcontractor reporting. Null if not provided.","uniqueKey":"data.items.[INDEX].tax_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].tax_id","typeLabel":"string | null"},"employment_type":{"type":"integer","description":"How the user is employed by your organization. `0` = not set, `1` = employee, `2` = 1099/vendor (independent contractor).","enum":[0,1,2],"example":1,"uniqueKey":"data.items.[INDEX].employment_type","typeLabel":"enum\u003cinteger>"},"description":{"oneOf":[{"type":"string","description":"Free-form notes about the user. Null if not set.","uniqueKey":"data.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Free-form notes about the user. Null if not set.","uniqueKey":"data.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].description","typeLabel":"string | null"},"theme":{"oneOf":[{"type":"string","description":"The UI color theme the user has selected for the app (for example `charcoal`). Can be null if the user hasn't chosen one.","example":"charcoal","uniqueKey":"data.items.[INDEX].theme.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UI color theme the user has selected for the app (for example `charcoal`). Can be null if the user hasn't chosen one.","example":"charcoal","uniqueKey":"data.items.[INDEX].theme.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].theme","typeLabel":"string | null"},"avatar_thumbnail_url":{"oneOf":[{"type":"string","description":"URL of the user's avatar thumbnail image. Can be null if the user hasn't uploaded a profile photo.","example":"https://cdn.contractorscloud.com/users/1159/thumb.jpeg","uniqueKey":"data.items.[INDEX].avatar_thumbnail_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL of the user's avatar thumbnail image. Can be null if the user hasn't uploaded a profile photo.","example":"https://cdn.contractorscloud.com/users/1159/thumb.jpeg","uniqueKey":"data.items.[INDEX].avatar_thumbnail_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].avatar_thumbnail_url","typeLabel":"string | null"},"auto_insured_at":{"oneOf":[{"type":"string","format":"date","description":"The date the user's auto insurance was last verified, formatted as `YYYY-MM-DD`. Null if not tracked.","uniqueKey":"data.items.[INDEX].auto_insured_at.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"The date the user's auto insurance was last verified, formatted as `YYYY-MM-DD`. Null if not tracked.","uniqueKey":"data.items.[INDEX].auto_insured_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].auto_insured_at","typeLabel":"string\u003cdate> | null"},"game_mode_daily_high_score":{"type":"integer","description":"The user's high score for the current day in the app's Game Mode feature.","example":0,"uniqueKey":"data.items.[INDEX].game_mode_daily_high_score","typeLabel":"integer"},"game_mode_total_score":{"type":"integer","description":"The user's all-time cumulative score in the app's Game Mode feature.","example":0,"uniqueKey":"data.items.[INDEX].game_mode_total_score","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":1159,"tenant_id":1,"default_company_id":6,"user_level_id":4,"email":"jane.doe@example.com","username":"jane.doe@example.com","first_name":"Jane","last_name":"Doe","initials":"JD","title":"Operations Manager","color":"#0a7d2c","timezone":"America/Chicago","started_at":"2019-06-03","terminated_at":null,"is_active":true,"phone_home":null,"phone_cell":"(555) 100-2048","phone_direct":null,"phone_direct_ext":null,"address_street":null,"address_city":null,"address_state":"WI","address_zip":null,"tax_id":null,"employment_type":0,"description":null,"theme":"charcoal","avatar_thumbnail_url":"https://cdn.contractorscloud.com/users/1159/thumb.jpeg","auto_insured_at":null,"game_mode_daily_high_score":0,"game_mode_total_score":0}],"first_page_url":"https://api.contractorscloud.com/api/v1/users?page[number]=1","from":1,"last_page":3,"last_page_url":"https://api.contractorscloud.com/api/v1/users?page[number]=3","links":[{"url":null,"label":"\u0026laquo; Previous","active":false},{"url":"https://api.contractorscloud.com/api/v1/users?page[number]=1","label":"1","active":true},{"url":"https://api.contractorscloud.com/api/v1/users?page[number]=2","label":"Next \u0026raquo;","active":false}],"next_page_url":"https://api.contractorscloud.com/api/v1/users?page[number]=2","path":"https://api.contractorscloud.com/api/v1/users","per_page":30,"prev_page_url":null,"to":30,"total":74},"examples":{"Example":{"title":"Example","value":{"current_page":1,"data":[{"id":1159,"tenant_id":1,"default_company_id":6,"user_level_id":4,"email":"jane.doe@example.com","username":"jane.doe@example.com","first_name":"Jane","last_name":"Doe","initials":"JD","title":"Operations Manager","color":"#0a7d2c","timezone":"America/Chicago","started_at":"2019-06-03","terminated_at":null,"is_active":true,"phone_home":null,"phone_cell":"(555) 100-2048","phone_direct":null,"phone_direct_ext":null,"address_street":null,"address_city":null,"address_state":"WI","address_zip":null,"tax_id":null,"employment_type":0,"description":null,"theme":"charcoal","avatar_thumbnail_url":"https://cdn.contractorscloud.com/users/1159/thumb.jpeg","auto_insured_at":null,"game_mode_daily_high_score":0,"game_mode_total_score":0}],"first_page_url":"https://api.contractorscloud.com/api/v1/users?page[number]=1","from":1,"last_page":3,"last_page_url":"https://api.contractorscloud.com/api/v1/users?page[number]=3","links":[{"url":null,"label":"\u0026laquo; Previous","active":false},{"url":"https://api.contractorscloud.com/api/v1/users?page[number]=1","label":"1","active":true},{"url":"https://api.contractorscloud.com/api/v1/users?page[number]=2","label":"Next \u0026raquo;","active":false}],"next_page_url":"https://api.contractorscloud.com/api/v1/users?page[number]=2","path":"https://api.contractorscloud.com/api/v1/users","per_page":30,"prev_page_url":null,"to":30,"total":74}}},"exampleType":"examples"}},"exampleType":"examples"},"dbdb49d3-b452-4124-97db-9909079f49db":{"description":"The request is missing a valid bearer token.","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":"Unauthenticated."},"examples":{"Example":{"title":"Example","value":{"message":"Unauthenticated."}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"739ac8a3-46c9-4712-800c-cf69cb68725f":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Authenticate with an API access token in the `Authorization` header: `Authorization: Bearer \u003ctoken>`. Create a token from the API Access Tokens page in Contractors Cloud, under Integrations.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"d40a5874-0065-43ae-a49c-61cdcc45656d":{"url":"https://api.contractorscloud.com/api/v1","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Authenticate with an API access token in the `Authorization` header: `Authorization: Bearer \u003ctoken>`. Create a token from the API Access Tokens page in Contractors Cloud, under Integrations.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Authenticate with an API access token in the `Authorization` header: `Authorization: Bearer \u003ctoken>`. Create a token from the API Access Tokens page in Contractors Cloud, under Integrations.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"contractorscloud","siteName":"Contractors Cloud API","title":"List users - Contractors Cloud API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-09T16:01:42.986Z","originalFileLocation":"api-reference/users/list-users.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 a paginated list of users in your organization. Use filters, sorts, includes, and appends to shape the result set.\">\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 users - Contractors Cloud API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns a paginated list of users in your organization. Use filters, sorts, includes, and appends to shape the result set.\">\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/users/list-users\">\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=Users\u0026amp;title=List+users\u0026amp;description=Returns+a+paginated+list+of+users+in+your+organization.+Use+filters%2C+sorts%2C+includes%2C+and+appends+to+shape+the+result+set.\u0026amp;theme=3408b2ae85cc8e2bb563fd2e\u0026amp;signature=bc186c2d99aa2d97818586657f74d6bc5ab23b5b30611f6118ec406913eb1edd\">\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 users - Contractors Cloud API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns a paginated list of users in your organization. Use filters, sorts, includes, and appends to shape the result set.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://contractorscloud.mintlify.app/_mintlify/api/og/v2?division=Users\u0026amp;title=List+users\u0026amp;description=Returns+a+paginated+list+of+users+in+your+organization.+Use+filters%2C+sorts%2C+includes%2C+and+appends+to+shape+the+result+set.\u0026amp;theme=3408b2ae85cc8e2bb563fd2e\u0026amp;signature=bc186c2d99aa2d97818586657f74d6bc5ab23b5b30611f6118ec406913eb1edd\">\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/users/list-users\">\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/users/list-users.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/users/list-users#webpage\",\"url\":\"https://api.contractorscloud.com/docs/api-reference/users/list-users\",\"name\":\"List users\",\"description\":\"Returns a paginated list of users in your organization. Use filters, sorts, includes, and appends to shape the result set.\",\"dateModified\":\"2026-10-09T16:01:42.986Z\",\"isPartOf\":{\"@id\":\"https://api.contractorscloud.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://api.contractorscloud.com/docs/api-reference/users/list-users#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://api.contractorscloud.com/docs/api-reference/users/list-users#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 users\",\"item\":\"https://api.contractorscloud.com/docs/api-reference/users/list-users\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://api.contractorscloud.com/docs/api-reference/users/list-users#apireference\",\"headline\":\"List users\",\"name\":\"List users\",\"description\":\"Returns a paginated list of users in your organization. Use filters, sorts, includes, and appends to shape the result set.\",\"url\":\"https://api.contractorscloud.com/docs/api-reference/users/list-users\",\"mainEntityOfPage\":{\"@id\":\"https://api.contractorscloud.com/docs/api-reference/users/list-users#webpage\"},\"dateModified\":\"2026-10-09T16:01:42.986Z\",\"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","description":"Returns a single workflow by id.","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","description":"Returns a single user by id. Pass the literal `me` as the id to fetch the currently authenticated user — the recommended way to verify that your token works and identify who you're connected as.","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","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","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 users - 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"]}