# Contractors Cloud API

- [Introduction](https://api.contractorscloud.com/docs/index.md): Authenticate and start making requests to the Contractors Cloud API.
- [Filtering and sorting](https://api.contractorscloud.com/docs/filtering-and-sorting.md): Narrow and order list results with filter and sort query parameters.
- [Relationships](https://api.contractorscloud.com/docs/relationships.md): Embed related resources and computed attributes with include and append.
- [Pagination](https://api.contractorscloud.com/docs/pagination.md): Page through large collections returned by list endpoints.
- [Rate limiting](https://api.contractorscloud.com/docs/rate-limiting.md): Request limits for the Contractors Cloud API and how to stay within them.
- [Versioning and stability](https://api.contractorscloud.com/docs/versioning.md): The compatibility contract for the Contractors Cloud API: what never changes in v1, what may be added at any time, and how deprecations work.
- [List projects](https://api.contractorscloud.com/docs/api-reference/projects/list-projects.md): Returns a paginated list of projects visible to your account — projects belonging to your organization's companies, or, for accounts with restricted visibility, only projects where you're on the project team or assigned as the account rep. Use filters, sorts, and includes to shape the result set.
- [Create project](https://api.contractorscloud.com/docs/api-reference/projects/create-project.md): Creates a new project. You can create projects only under companies you belong to. The submitted `contact_ids` are linked to both the new project and its account, which also updates the account's cached primary contact details. A system note ("Project was created.") is added automatically. When `add…
- [Get project](https://api.contractorscloud.com/docs/api-reference/projects/get-project.md): Returns a single project by id.
- [Update project](https://api.contractorscloud.com/docs/api-reference/projects/update-project.md): Updates an existing project. Only the fields you send are changed. `company_id` cannot be changed after creation, and `contact_ids` and company custom field values aren't managed through this endpoint. `number` can only be set here — a newly created project holds the placeholder value `Lead` until y…
- [Delete project](https://api.contractorscloud.com/docs/api-reference/projects/delete-project.md): Permanently deletes a project. This is irreversible — there is no restore endpoint.
- [List project contacts](https://api.contractorscloud.com/docs/api-reference/project-contacts/list-project-contacts.md): Returns a paginated list of the contacts linked to a project. Each contact carries a `linked_contact` object describing its link to the project. Results are ordered by the contact's position on the project by default. Use filters, sorts, and includes to shape the result set.
- [Create project contact](https://api.contractorscloud.com/docs/api-reference/project-contacts/create-project-contact.md): Links an existing contact to a project and returns the linked contact. The contact must already exist in your organization — create it first with [Create contact](/api-reference/contacts/create-contact) if it doesn't. Linking a contact that's already linked to this project updates the existing link'…
- [Get project contact](https://api.contractorscloud.com/docs/api-reference/project-contacts/get-project-contact.md): Returns a single contact linked to a project, along with its `linked_contact` details.
- [Update project contact](https://api.contractorscloud.com/docs/api-reference/project-contacts/update-project-contact.md): Updates the attributes of a contact's link to a project — the underlying contact record itself isn't changed. Only the fields you send are changed.
- [Delete project contact](https://api.contractorscloud.com/docs/api-reference/project-contacts/delete-project-contact.md): Unlinks a contact from a project. The contact record itself isn't deleted — it's only removed from this project's list of linked contacts, and remains available to link to this or any other project.
- [List project notes](https://api.contractorscloud.com/docs/api-reference/project-notes/list-project-notes.md): Returns a paginated list of a project's notes. Contractors Cloud adds system-generated notes to a project automatically as its data changes, so a project's notes form a complete activity feed alongside any comments you add. Use filters, sorts, and includes to shape the result set.
- [Create project note](https://api.contractorscloud.com/docs/api-reference/project-notes/create-project-note.md): Adds a note to a project. Contractors Cloud also adds system-generated notes to a project automatically as its data changes, so this endpoint is for adding your own comments alongside that activity.
- [Get project note](https://api.contractorscloud.com/docs/api-reference/project-notes/get-project-note.md): Returns a single project note by id.
- [Update project note](https://api.contractorscloud.com/docs/api-reference/project-notes/update-project-note.md): Updates an existing project note. Only `type_id` and `is_visible_on_customer_portal` can be changed — a note's `body` can't be edited after it's created.
- [Delete project note](https://api.contractorscloud.com/docs/api-reference/project-notes/delete-project-note.md): Deletes a project note. Deleting a note requires elevated account permissions in your organization — accounts without them receive a 403.
- [List project files](https://api.contractorscloud.com/docs/api-reference/project-files/list-project-files.md): Returns a paginated list of a project's files, including both photos and general files. Sensitive files are excluded from the results for users without financial visibility in your organization. Use filters, sorts, and includes to shape the result set.
- [Create project file](https://api.contractorscloud.com/docs/api-reference/project-files/create-project-file.md): Uploads a new file or photo to a project and returns the created resource. Send either an uploaded `file` or a `url` to fetch and store — not both.
- [Get project file](https://api.contractorscloud.com/docs/api-reference/project-files/get-project-file.md): Returns a single project file by id. Sensitive files return `404` for users without financial visibility.
- [Update project file](https://api.contractorscloud.com/docs/api-reference/project-files/update-project-file.md): Updates an existing project file. Only the fields you send are changed. `name` is optional but can't be set to an empty value.
- [Delete project file](https://api.contractorscloud.com/docs/api-reference/project-files/delete-project-file.md): Removes the file record from the project. A note documenting the deletion is added to the project's activity feed, and the project's workflow progress may update automatically. Deleting a file also removes it from any project albums that include it. Deleting a file requires file-management permissio…
- [List project albums](https://api.contractorscloud.com/docs/api-reference/project-albums/list-project-albums.md): Returns a paginated list of a project's photo albums. Use filters, sorts, and includes to shape the result set.
- [Create project album](https://api.contractorscloud.com/docs/api-reference/project-albums/create-project-album.md): Creates a new photo album on a project and returns the created resource. A note documenting the new album is added to the project's activity feed.
- [Get project album](https://api.contractorscloud.com/docs/api-reference/project-albums/get-project-album.md): Returns a single project album by id.
- [Update project album](https://api.contractorscloud.com/docs/api-reference/project-albums/update-project-album.md): Updates an existing project album. Only the fields you send are changed; all fields are optional, but `name` can't be set to an empty value. A note documenting the update is added to the project's activity feed.
- [Delete project album](https://api.contractorscloud.com/docs/api-reference/project-albums/delete-project-album.md): Deletes a project album along with every item in it. The underlying project photos themselves aren't deleted — only their placement in this album. A note documenting the deletion is added to the project's activity feed.
- [Download project album PDF](https://api.contractorscloud.com/docs/api-reference/project-albums/download-project-album-pdf.md): Returns a PDF rendering of the album's photos, laid out according to the album's `photos_per_page` setting. An item whose underlying photo has since been deleted is skipped in the rendering.
- [List album items](https://api.contractorscloud.com/docs/api-reference/album-items/list-album-items.md): Returns a paginated list of the photos placed in an album, ordered by their position. Use filters, sorts, and includes to shape the result set.
- [Create album item](https://api.contractorscloud.com/docs/api-reference/album-items/create-album-item.md): Adds a photo to an album and returns the created item.
- [Get album item](https://api.contractorscloud.com/docs/api-reference/album-items/get-album-item.md): Returns a single album item by id.
- [Update album item](https://api.contractorscloud.com/docs/api-reference/album-items/update-album-item.md): Moves an album item to a new 1-based position, shifting other items to make room. This is the only change this endpoint supports — the photo an item displays can't be swapped; delete the item and add a new one instead.
- [Delete album item](https://api.contractorscloud.com/docs/api-reference/album-items/delete-album-item.md): Removes a photo from the album. The underlying project file itself isn't deleted — only its placement in this album. A note documenting the removal is added to the project's activity feed, and the album's `total_photos` updates automatically.
- [List project custom fields](https://api.contractorscloud.com/docs/api-reference/project-custom-fields/list-project-custom-fields.md): Returns a paginated list of the custom field values set on a project. Each value corresponds to one of the project's company's custom field definitions — see [List company custom fields](/api-reference/company-custom-fields/list-company-custom-fields). Use filters and includes to shape the result se…
- [Create project custom field](https://api.contractorscloud.com/docs/api-reference/project-custom-fields/create-project-custom-field.md): Sets a value for one of the project's company's custom field definitions and returns the created resource. `company_custom_field_id` must belong to the project's own company. Creating a value doesn't check for an existing value on the same `company_custom_field_id` — a second request creates a separ…
- [Get project custom field](https://api.contractorscloud.com/docs/api-reference/project-custom-fields/get-project-custom-field.md): Returns a single project custom field value by id.
- [Update project custom field](https://api.contractorscloud.com/docs/api-reference/project-custom-fields/update-project-custom-field.md): Updates the value of an existing project custom field. Only `value` can be changed.
- [Delete project custom field](https://api.contractorscloud.com/docs/api-reference/project-custom-fields/delete-project-custom-field.md): Deletes a project custom field value. The company's custom field definition itself isn't affected.
- [List project claims](https://api.contractorscloud.com/docs/api-reference/project-claims/list-project-claims.md): Returns a paginated list of the insurance claims tracked on a project. Claims are read-only through the API. Use filters and sorts to shape the result set.
- [Get project claim](https://api.contractorscloud.com/docs/api-reference/project-claims/get-project-claim.md): Returns a single project claim by id.
- [List project permits](https://api.contractorscloud.com/docs/api-reference/project-permits/list-project-permits.md): Returns a paginated list of the permits tracked on a project. Permits are read-only through the API. There's no default value for `filter[is_deleted]`, so permits that have been removed in Contractors Cloud remain in the results unless you explicitly filter them out. Use filters and sorts to shape t…
- [Get project permit](https://api.contractorscloud.com/docs/api-reference/project-permits/get-project-permit.md): Returns a single project permit by id.
- [List project contracts](https://api.contractorscloud.com/docs/api-reference/project-contracts/list-project-contracts.md): Returns a paginated list of the contracts recorded on a project. Contracts are read-only through the API. Financial fields on each contract are omitted from the response entirely for users without the matching financial visibility in your organization: the 17 invoice and payment fields (`financials_…
- [Get project contract](https://api.contractorscloud.com/docs/api-reference/project-contracts/get-project-contract.md): Returns a single project contract by id. Financial fields are omitted from the response entirely for users without the matching financial visibility in your organization: the 17 invoice and payment fields, the 5 expense fields, and the 4 payout fields are each controlled separately — see [Contract](…
- [Download homeowner certificate PDF](https://api.contractorscloud.com/docs/api-reference/project-contracts/download-homeowner-certificate-pdf.md): Returns the contract's Homeowner Certificate of Completion (HCOC) as a PDF — a letterhead certificate confirming the contracted work is complete, including the completion date and any completion comments recorded on the contract.
- [Download insurance certificate PDF](https://api.contractorscloud.com/docs/api-reference/project-contracts/download-insurance-certificate-pdf.md): Returns the contract's Insurance Certificate of Completion (ICOC) as a PDF, documenting the completed work against the insurance claim linked to the contract. The `format` parameter selects a letter-style certificate or an invoice-style rendering.
- [Download job statement PDF](https://api.contractorscloud.com/docs/api-reference/project-contracts/download-job-statement-pdf.md): Returns a job statement for the contract as a PDF — a dated ledger of the invoices, payments, and credit memos recorded against the contract, with a running balance, the balance due, and any pending transactions listed separately.
- [Download customer statement PDF](https://api.contractorscloud.com/docs/api-reference/project-contracts/download-customer-statement-pdf.md): Returns a customer statement as a PDF. Where the job statement covers a single contract, the customer statement is a dated ledger of the invoices, payments, credit memos, and refunds recorded across the entire account the project belongs to, with a running balance and any pending transactions listed…
- [List contract invoices](https://api.contractorscloud.com/docs/api-reference/contract-invoices/list-contract-invoices.md): Returns a paginated list of the invoices billed against a project contract. Invoices are read-only through the API. Removed invoices are excluded by default — pass `filter[is_deleted]=1` to include them. The 20 financial fields on each invoice (`financials_pending_amount` through `financials_to_pay_…
- [Get contract invoice](https://api.contractorscloud.com/docs/api-reference/contract-invoices/get-contract-invoice.md): Returns a single contract invoice by id. The 20 financial fields (`financials_pending_amount` through `financials_to_pay_amount`) are omitted from the response entirely for users without financial visibility in your organization, though in practice such users receive a `403` instead.
- [Download contract invoice PDF](https://api.contractorscloud.com/docs/api-reference/contract-invoices/download-contract-invoice-pdf.md): Returns a PDF rendering of a single contract invoice.
- [Download contract invoices PDF](https://api.contractorscloud.com/docs/api-reference/contract-invoices/download-contract-invoices-pdf.md): Returns a single PDF combining every invoice billed against the contract.
- [List project work orders](https://api.contractorscloud.com/docs/api-reference/work-orders/list-project-work-orders.md): Returns a paginated list of the work orders scheduled on a project. Use filters, sorts, and includes to shape the result set.
- [Get project work order](https://api.contractorscloud.com/docs/api-reference/work-orders/get-project-work-order.md): Returns a single project work order by id.
- [Update project work order](https://api.contractorscloud.com/docs/api-reference/work-orders/update-project-work-order.md): Updates an existing work order. Only the fields you send are changed; all fields are optional.
- [Download project work order PDF](https://api.contractorscloud.com/docs/api-reference/work-orders/download-project-work-order-pdf.md): Returns a PDF rendering of the work order.
- [List project material orders](https://api.contractorscloud.com/docs/api-reference/material-orders/list-project-material-orders.md): Returns a paginated list of the material orders placed for a project's work orders. Material orders are read-only through the API. Use filters, sorts, and includes to shape the result set.
- [Get project material order](https://api.contractorscloud.com/docs/api-reference/material-orders/get-project-material-order.md): Returns a single project material order by id.
- [Download project material order PDF](https://api.contractorscloud.com/docs/api-reference/material-orders/download-project-material-order-pdf.md): Returns a PDF rendering of the material order.
- [List accounts](https://api.contractorscloud.com/docs/api-reference/accounts/list-accounts.md): Returns a paginated list of customer accounts in your organization. Depending on your permission level, you may only see accounts you're the rep for, or that belong to a project you're on the team for.
- [Create account](https://api.contractorscloud.com/docs/api-reference/accounts/create-account.md): Creates a new customer account — the person or business a project is sold to.
- [Get account](https://api.contractorscloud.com/docs/api-reference/accounts/get-account.md): Returns a single account by id. Depending on your permission level, an account outside your visible scope returns a 404 the same as a nonexistent one.
- [Update account](https://api.contractorscloud.com/docs/api-reference/accounts/update-account.md): Updates an existing account. Only the fields you send are changed; when present, `type`, `name`, and the primary address fields can't be set to empty values. Depending on your permission level, an account outside your visible scope returns a 404 the same as a nonexistent one.
- [Delete account](https://api.contractorscloud.com/docs/api-reference/accounts/delete-account.md): Permanently deletes an account. This is irreversible — there is no restore endpoint. Depending on your permission level, an account outside your visible scope returns a 404 the same as a nonexistent one.
- [List account contacts](https://api.contractorscloud.com/docs/api-reference/account-contacts/list-account-contacts.md): Returns a paginated list of the contacts linked to an account. Each contact carries a `linked_contact` object describing its link to the account. Results are ordered by the contact's position on the account by default. Use filters, sorts, and includes to shape the result set.
- [Create account contact](https://api.contractorscloud.com/docs/api-reference/account-contacts/create-account-contact.md): Links an existing contact to an account and returns the linked contact. The contact must already exist in your organization — create it first with [Create contact](/api-reference/contacts/create-contact) if it doesn't. Linking a contact that's already linked to this account updates the existing link…
- [Get account contact](https://api.contractorscloud.com/docs/api-reference/account-contacts/get-account-contact.md): Returns a single contact linked to an account, along with its `linked_contact` details.
- [Update account contact](https://api.contractorscloud.com/docs/api-reference/account-contacts/update-account-contact.md): Updates the attributes of a contact's link to an account — the underlying contact record itself isn't changed. Only the fields you send are changed.
- [Delete account contact](https://api.contractorscloud.com/docs/api-reference/account-contacts/delete-account-contact.md): Unlinks a contact from an account. The contact record itself isn't deleted — it's only removed from this account's list of linked contacts, and remains available to link to this or any other account.
- [List account notes](https://api.contractorscloud.com/docs/api-reference/account-notes/list-account-notes.md): Returns a paginated list of an account's notes. Contractors Cloud adds system-generated notes to an account automatically as its data changes, so an account's notes form a complete activity feed alongside any comments you add. Notes can't be edited or deleted once created. Use filters, sorts, and in…
- [Create account note](https://api.contractorscloud.com/docs/api-reference/account-notes/create-account-note.md): Adds a note to an account. Contractors Cloud also adds system-generated notes to an account automatically as its data changes, so this endpoint is for adding your own comments alongside that activity.
- [Get account note](https://api.contractorscloud.com/docs/api-reference/account-notes/get-account-note.md): Returns a single account note by id.
- [List contacts](https://api.contractorscloud.com/docs/api-reference/contacts/list-contacts.md): Returns a paginated list of contacts in your organization. Use filters, sorts, and includes to shape the result set.
- [Create contact](https://api.contractorscloud.com/docs/api-reference/contacts/create-contact.md): Creates a new contact and returns the created resource.
- [Get contact](https://api.contractorscloud.com/docs/api-reference/contacts/get-contact.md): Returns a single contact by id.
- [Update contact](https://api.contractorscloud.com/docs/api-reference/contacts/update-contact.md): Updates an existing contact. Only the fields you send are changed; all fields are optional, but `first_name` and `last_name` cannot be set to empty values.
- [Delete contact](https://api.contractorscloud.com/docs/api-reference/contacts/delete-contact.md): Deletes a contact. A contact with no linked contacts is permanently deleted; a contact that has other contacts linked to it is deactivated (`status` set to `false`) instead.
- [List contact notes](https://api.contractorscloud.com/docs/api-reference/contact-notes/list-contact-notes.md): Returns a paginated list of a contact's notes. Contractors Cloud adds system-generated notes to a contact automatically as it changes, so a contact's notes form a complete activity feed alongside any comments you add. Notes can't be edited or deleted once created. Use filters, sorts, and includes to…
- [Create contact note](https://api.contractorscloud.com/docs/api-reference/contact-notes/create-contact-note.md): Adds a note to a contact. Contractors Cloud also adds system-generated notes to a contact automatically as it changes, so this endpoint is for adding your own comments alongside that activity.
- [Get contact note](https://api.contractorscloud.com/docs/api-reference/contact-notes/get-contact-note.md): Returns a single contact note by id.
- [List leads](https://api.contractorscloud.com/docs/api-reference/leads/list-leads.md): Returns a paginated list of leads in your organization. Use filters, sorts, and includes to shape the result set.
- [Submit leads](https://api.contractorscloud.com/docs/api-reference/leads/submit-leads.md): Submits one or more leads to a lead connection for asynchronous processing. Send the request body in the format your connection's `data_type` accepts: a JSON object or array for `json` connections, an uploaded spreadsheet for `excel` connections, or a raw text body with a `text/plain` content type f…
- [Delete many leads](https://api.contractorscloud.com/docs/api-reference/leads/delete-many-leads.md): Deletes every lead matching the current filters. This is a bulk, irreversible operation — with `action=delete` and no filters applied, every lead in your organization is deleted. Always run with `action=preview` first to see how many leads would be affected.
- [Get lead](https://api.contractorscloud.com/docs/api-reference/leads/get-lead.md): Returns a single lead by id.
- [Update lead](https://api.contractorscloud.com/docs/api-reference/leads/update-lead.md): Edits a lead's submitted data. Each key in the request body is deep-merged into the lead's existing `data` — new keys are added, matching keys are overwritten, and nested objects are merged key by key rather than replaced outright. Everything you don't send is left untouched (a partial patch, not a…
- [Delete lead](https://api.contractorscloud.com/docs/api-reference/leads/delete-lead.md): Deletes a lead. A lead that has already been converted into a project (`successful`) can still be deleted — deleting the lead doesn't affect the project it created.
- [Process lead](https://api.contractorscloud.com/docs/api-reference/leads/process-lead.md): Re-runs processing for a lead, re-deriving its data and validating it against your connection's field mapping. Processing happens asynchronously — the lead's `status` becomes `processing` immediately, then moves to `ready`, `needs-review`, or `error` once finished.
- [Convert lead](https://api.contractorscloud.com/docs/api-reference/leads/convert-lead.md): Converts a `ready` lead into a project, creating any contacts found in its derived data along the way. Conversion happens asynchronously — the lead's `status` becomes `converting` immediately, then `successful` once the project has been created, with `project_id` set to the new project's id.
- [List lead connections](https://api.contractorscloud.com/docs/api-reference/lead-connections/list-lead-connections.md): Returns a paginated list of lead connections in your organization. Use filters, sorts, and includes to shape the result set.
- [Create lead connection](https://api.contractorscloud.com/docs/api-reference/lead-connections/create-lead-connection.md): Creates a new lead connection for a company in your organization and returns the created resource.
- [Get lead connection](https://api.contractorscloud.com/docs/api-reference/lead-connections/get-lead-connection.md): Returns a single lead connection by id.
- [Update lead connection](https://api.contractorscloud.com/docs/api-reference/lead-connections/update-lead-connection.md): Updates an existing lead connection. Only the fields you send are changed; all fields are optional. `company_id` cannot be changed after creation — the API ignores it if you send it here.
- [Delete lead connection](https://api.contractorscloud.com/docs/api-reference/lead-connections/delete-lead-connection.md): Permanently deletes the lead connection. This cascades to every lead submitted through it, along with its field maps and rep assignments — all of that data is permanently removed and cannot be recovered.
- [List lead connection settings](https://api.contractorscloud.com/docs/api-reference/lead-connections/list-lead-connection-settings.md): Returns every setting for a lead connection with its current value. Four settings are available: `lead_rep_assignment_method` (`default` or `round-robin`, defaults to `default`), `automatically_convert_leads` (`yes` or `no`, defaults to `yes`), `ignore_required_custom_fields` (`yes` or `no`, default…
- [Get lead connection setting](https://api.contractorscloud.com/docs/api-reference/lead-connections/get-lead-connection-setting.md): Returns a single lead connection setting by key. See [List lead connection settings](/api-reference/lead-connections/list-lead-connection-settings) for the four available keys. Setting values are changed in the Contractors Cloud web app, not through this API.
- [List field maps](https://api.contractorscloud.com/docs/api-reference/field-maps/list-field-maps.md): Returns a paginated list of field maps for a lead connection. Use filters and includes to shape the result set. Returns `422` if the connection's `data_type` is `text` — field maps aren't available for text connections.
- [Create field map](https://api.contractorscloud.com/docs/api-reference/field-maps/create-field-map.md): Creates a field map for a lead connection and returns the created resource. `source` and `target` must each be unique within the connection. Returns `422` if the connection's `data_type` is `text` — field maps aren't available for text connections.
- [Get field map](https://api.contractorscloud.com/docs/api-reference/field-maps/get-field-map.md): Returns a single field map by id. Returns `422` if the connection's `data_type` is `text` — field maps aren't available for text connections.
- [Update field map](https://api.contractorscloud.com/docs/api-reference/field-maps/update-field-map.md): Updates an existing field map. Only the fields you send are changed; all fields are optional. `source` and `target` must each remain unique within the connection. Returns `422` if the connection's `data_type` is `text` — field maps aren't available for text connections.
- [Delete field map](https://api.contractorscloud.com/docs/api-reference/field-maps/delete-field-map.md): Permanently deletes the field map. Returns `422` if the connection's `data_type` is `text` — field maps aren't available for text connections.
- [List available target fields](https://api.contractorscloud.com/docs/api-reference/field-maps/list-available-target-fields.md): Returns the target fields this lead connection can map to, based on its `data_type`. `json` connections expose 15 target fields; `excel` connections expose those same 15 plus 15 more covering financial and date columns. Call this endpoint to get your connection's current list rather than hardcoding…
- [Generate field maps](https://api.contractorscloud.com/docs/api-reference/field-maps/generate-field-maps.md): Generates field maps automatically from one example lead, instead of creating them one at a time.
- [List rep assignments](https://api.contractorscloud.com/docs/api-reference/rep-assignments/list-rep-assignments.md): Returns a paginated list of rep assignments for a lead connection — the reps included in its round-robin rotation. Use filters, sorts, and includes to shape the result set.
- [Create rep assignment](https://api.contractorscloud.com/docs/api-reference/rep-assignments/create-rep-assignment.md): Adds a rep to a lead connection's round-robin rotation. `rep_id` must be a user assigned to the connection's company, and can only be assigned to the same connection once.
- [Get rep assignment](https://api.contractorscloud.com/docs/api-reference/rep-assignments/get-rep-assignment.md): Returns a single rep assignment by id.
- [Delete rep assignment](https://api.contractorscloud.com/docs/api-reference/rep-assignments/delete-rep-assignment.md): Permanently removes the rep from the connection's round-robin rotation. There's no update endpoint for rep assignments — to change the rotation, delete an assignment and create a new one.
- [List companies](https://api.contractorscloud.com/docs/api-reference/companies/list-companies.md): Returns a paginated list of companies in your organization. Only companies you belong to are returned.
- [Get company](https://api.contractorscloud.com/docs/api-reference/companies/get-company.md): Returns a single company by id. Only companies you belong to are accessible.
- [List company appointment types](https://api.contractorscloud.com/docs/api-reference/company-appointment-types/list-company-appointment-types.md): Returns a paginated list of appointment types configured for a company, used when scheduling appointments for that company.
- [Get company appointment type](https://api.contractorscloud.com/docs/api-reference/company-appointment-types/get-company-appointment-type.md): Returns a single appointment type definition by id.
- [List company custom fields](https://api.contractorscloud.com/docs/api-reference/company-custom-fields/list-company-custom-fields.md): Returns a paginated list of custom field definitions configured for a company's projects, ordered by position by default.
- [Get company custom field](https://api.contractorscloud.com/docs/api-reference/company-custom-fields/get-company-custom-field.md): Returns a single custom field definition by id.
- [List events](https://api.contractorscloud.com/docs/api-reference/events/list-events.md): Returns a paginated list of events configured for a company.
- [Get event](https://api.contractorscloud.com/docs/api-reference/events/get-event.md): Returns a single event by id.
- [List lead sources](https://api.contractorscloud.com/docs/api-reference/lead-sources/list-lead-sources.md): Returns a paginated list of lead sources configured for a company. A project's `lead_id` and a lead connection's `lead_source_id` both reference these records.
- [Get lead source](https://api.contractorscloud.com/docs/api-reference/lead-sources/get-lead-source.md): Returns a single lead source by id.
- [List milestones](https://api.contractorscloud.com/docs/api-reference/milestones/list-milestones.md): Returns a paginated list of milestones configured for a company, ordered by position by default.
- [Get milestone](https://api.contractorscloud.com/docs/api-reference/milestones/get-milestone.md): Returns a single milestone by id.
- [List company roles](https://api.contractorscloud.com/docs/api-reference/company-roles/list-company-roles.md): Returns a paginated list of the roles configured for a company, used to designate responsibilities such as the attendee positions on a company's appointment types.
- [Get company role](https://api.contractorscloud.com/docs/api-reference/company-roles/get-company-role.md): Returns a single company role by id.
- [List workflows](https://api.contractorscloud.com/docs/api-reference/workflows/list-workflows.md): Returns a paginated list of workflows configured for a company.
- [Get workflow](https://api.contractorscloud.com/docs/api-reference/workflows/get-workflow.md): Returns a single workflow by id.
- [List users](https://api.contractorscloud.com/docs/api-reference/users/list-users.md): Returns a paginated list of users in your organization. Use filters, sorts, includes, and appends to shape the result set.
- [Get user](https://api.contractorscloud.com/docs/api-reference/users/get-user.md): 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.
- [List teams](https://api.contractorscloud.com/docs/api-reference/teams/list-teams.md): Returns a paginated list of the teams in your organization. Use filters, sorts, and includes to shape the result set.
- [Create team](https://api.contractorscloud.com/docs/api-reference/teams/create-team.md): Creates a new team and returns the created resource. A note documenting the creation is added to the team's [Team Notes](/api-reference/team-notes/list-team-notes) automatically.
- [Get team](https://api.contractorscloud.com/docs/api-reference/teams/get-team.md): Returns a single team by id.
- [Update team](https://api.contractorscloud.com/docs/api-reference/teams/update-team.md): Updates an existing team. Only the fields you send are changed. A note documenting what changed — leader, name, comment, or active status — is added to the team's [Team Notes](/api-reference/team-notes/list-team-notes) automatically. Teams aren't deleted through the API; deactivate a team by setting…
- [List team members](https://api.contractorscloud.com/docs/api-reference/team-members/list-team-members.md): Returns a paginated list of a team's members. Use filters, sorts, and includes to shape the result set.
- [Create team member](https://api.contractorscloud.com/docs/api-reference/team-members/create-team-member.md): Adds a user as a member of the team and returns the created resource. A note documenting the addition is added to the team's [Team Notes](/api-reference/team-notes/list-team-notes) automatically.
- [Get team member](https://api.contractorscloud.com/docs/api-reference/team-members/get-team-member.md): Returns a single team member by id. Returns `404` if the member doesn't exist or doesn't belong to this team.
- [Update team member](https://api.contractorscloud.com/docs/api-reference/team-members/update-team-member.md): Updates a team member's active status — the only field that can be changed after creation. To reassign the membership to a different user, delete this member and create a new one.
- [Delete team member](https://api.contractorscloud.com/docs/api-reference/team-members/delete-team-member.md): Removes a member from the team. This is a permanent removal, not a deactivation — the membership record no longer exists afterward. A note documenting the removal is added to the team's [Team Notes](/api-reference/team-notes/list-team-notes) automatically.
- [List team companies](https://api.contractorscloud.com/docs/api-reference/team-companies/list-team-companies.md): Returns a paginated list of the companies assigned to a team. Use filters and includes to shape the result set — sorting isn't supported, so results are returned in no guaranteed order.
- [Create team company](https://api.contractorscloud.com/docs/api-reference/team-companies/create-team-company.md): Assigns a company to the team and returns the created resource. A note documenting the addition is added to the team's [Team Notes](/api-reference/team-notes/list-team-notes) automatically.
- [Get team company](https://api.contractorscloud.com/docs/api-reference/team-companies/get-team-company.md): Returns a single team company assignment by id. Returns `404` if the assignment doesn't exist or doesn't belong to this team.
- [Delete team company](https://api.contractorscloud.com/docs/api-reference/team-companies/delete-team-company.md): Removes a company's assignment from the team. A note documenting the removal is added to the team's [Team Notes](/api-reference/team-notes/list-team-notes) automatically.
- [List team notes](https://api.contractorscloud.com/docs/api-reference/team-notes/list-team-notes.md): Returns a paginated list of a team's notes. Team Notes are a read-only activity log Contractors Cloud generates automatically as a team's details, members, and companies change — there's no way to create one directly. Use filters, sorts, and includes to shape the result set.
- [Get team note](https://api.contractorscloud.com/docs/api-reference/team-notes/get-team-note.md): Returns a single team note by id. Returns `404` if the note doesn't exist or doesn't belong to this team.
- [List appointments](https://api.contractorscloud.com/docs/api-reference/appointments/list-appointments.md): Returns a paginated list of appointments visible to your account — every appointment in your organization, or, for accounts with restricted visibility, only appointments where you're an attendee. Use filters, sorts, and includes to shape the result set.
- [Create appointment](https://api.contractorscloud.com/docs/api-reference/appointments/create-appointment.md): Creates a new appointment. When linked to a project, a note is added to that project's activity feed automatically, and the project's workflow progress may update automatically as a result. When `address_latitude` and `address_longitude` are omitted, the address is geocoded automatically.
- [Get appointment](https://api.contractorscloud.com/docs/api-reference/appointments/get-appointment.md): Returns a single appointment by id.
- [Update appointment](https://api.contractorscloud.com/docs/api-reference/appointments/update-appointment.md): Updates an existing appointment. What can be changed depends on the appointment's current state.
- [Delete appointment](https://api.contractorscloud.com/docs/api-reference/appointments/delete-appointment.md): Deletes an appointment along with its attendees. Deleting an appointment linked to a project adds a cancellation note to the project's activity feed, and the project's workflow progress may update automatically as a result.
- [Get calendar feed address](https://api.contractorscloud.com/docs/api-reference/appointments/get-calendar-feed-address.md): Returns an opaque address for a calendar feed of your appointments, for use with [Download calendar feed](/api-reference/appointments/download-calendar-feed). The address captures the requesting user and any of the [List appointments](/api-reference/appointments/list-appointments) filters supplied a…
- [Download calendar feed](https://api.contractorscloud.com/docs/api-reference/appointments/download-calendar-feed.md): Returns an iCalendar (`.ics`) rendering of the appointments matching the address returned by [Get calendar feed address](/api-reference/appointments/get-calendar-feed-address), suitable for subscribing to from calendar apps. This endpoint does not require a bearer token — it authenticates using the…
- [List attendees](https://api.contractorscloud.com/docs/api-reference/appointment-attendees/list-attendees.md): Returns a paginated list of an appointment's attendees. Use filters and includes to shape the result set.
- [Create attendee](https://api.contractorscloud.com/docs/api-reference/appointment-attendees/create-attendee.md): Adds a new attendee to an appointment. When the appointment is `confirmed` and is upcoming or currently in progress, an updated invite is emailed to every attendee.
- [Get attendee](https://api.contractorscloud.com/docs/api-reference/appointment-attendees/get-attendee.md): Returns a single attendee by id.
- [Update attendee](https://api.contractorscloud.com/docs/api-reference/appointment-attendees/update-attendee.md): Updates an existing attendee. Only `is_optional` can be changed. When the appointment is `confirmed` and is upcoming or currently in progress, updated calendar invites are emailed to all attendees.
- [Delete attendee](https://api.contractorscloud.com/docs/api-reference/appointment-attendees/delete-attendee.md): Removes an attendee from the appointment. When the appointment is `confirmed` and is upcoming or currently in progress, the removed attendee receives a cancellation and the remaining attendees receive an updated invite.
- [List tasks](https://api.contractorscloud.com/docs/api-reference/tasks/list-tasks.md): Returns a paginated list of tasks visible to your account — every task in your organization, or, for accounts with restricted project visibility, only tasks assigned directly to you or to an active team you belong to. Use filters, sorts, and includes to shape the result set. A task outside your visi…
- [Create task](https://api.contractorscloud.com/docs/api-reference/tasks/create-task.md): Creates a new task and returns the created resource. A system note documenting the creation is added to the task's notes automatically, and when the task is linked to a project, a note is also added to that project's activity feed. When `notifies_on_create` is `true`, the assignee (or each member of…
- [Get task](https://api.contractorscloud.com/docs/api-reference/tasks/get-task.md): Returns a single task by id. Returns `404` if the task exists but isn't visible to your account — see [List tasks](/api-reference/tasks/list-tasks) for visibility rules.
- [Update task](https://api.contractorscloud.com/docs/api-reference/tasks/update-task.md): Updates an existing task. Only the fields you send are changed; all fields are optional, but `subject` cannot be set to an empty value.
- [Delete task](https://api.contractorscloud.com/docs/api-reference/tasks/delete-task.md): Deletes a task along with its notes. When the task is linked to a project, a note is added to that project's activity feed. Any user who can see a task can update or delete it — deletion isn't restricted to the task's creator or assignee.
- [List task notes](https://api.contractorscloud.com/docs/api-reference/task-notes/list-task-notes.md): Returns a paginated list of a task's notes. Contractors Cloud adds system-generated notes to a task automatically as it changes, so a task's notes include both the comments you add and that system activity. Use filters, sorts, and includes to shape the result set.
- [Create task note](https://api.contractorscloud.com/docs/api-reference/task-notes/create-task-note.md): Adds a note to a task. Contractors Cloud also adds system-generated notes to a task automatically as it changes, so this endpoint is for adding your own comments alongside that activity.
- [Get task note](https://api.contractorscloud.com/docs/api-reference/task-notes/get-task-note.md): Returns a single task note by id.
- [Update task note](https://api.contractorscloud.com/docs/api-reference/task-notes/update-task-note.md): Updates an existing task note's text.
- [Delete task note](https://api.contractorscloud.com/docs/api-reference/task-notes/delete-task-note.md): Deletes a task note. A note created by another user cannot be deleted.
- [List jet streams](https://api.contractorscloud.com/docs/api-reference/jet-streams/list-jet-streams.md): Returns a paginated list of jet streams — threaded activity streams that loop a set of users into updates on a topic, optionally tied to a project. Use filters, sorts, and includes to shape the result set.
- [Create jet stream](https://api.contractorscloud.com/docs/api-reference/jet-streams/create-jet-stream.md): Creates a jet stream and returns the created resource. Use this to loop a set of users into updates on a topic, optionally tied to a project, and notify them as the conversation progresses.
- [Get jet stream](https://api.contractorscloud.com/docs/api-reference/jet-streams/get-jet-stream.md): Returns a single jet stream by id.
- [Update jet stream](https://api.contractorscloud.com/docs/api-reference/jet-streams/update-jet-stream.md): Updates a jet stream's title or topic. Only the fields you send are changed, and only the stream's creator can update it — other participants receive a `403`. Refreshes your own read state on the stream.
- [Delete jet stream](https://api.contractorscloud.com/docs/api-reference/jet-streams/delete-jet-stream.md): Permanently deletes a jet stream.
- [Mark jet streams read](https://api.contractorscloud.com/docs/api-reference/jet-streams/mark-jet-streams-read.md): Marks every jet stream matching the current filters as read for you. Use this to clear your unread indicators in bulk instead of calling [Mark jet stream read](/api-reference/jet-streams/mark-jet-stream-read) one at a time.
- [Mark jet stream read](https://api.contractorscloud.com/docs/api-reference/jet-streams/mark-jet-stream-read.md): Marks a single jet stream as read for you and returns the updated resource. Only your own read state is affected.
- [List jet stream users](https://api.contractorscloud.com/docs/api-reference/jet-stream-users/list-jet-stream-users.md): Returns a paginated list of a jet stream's participants. Use filters, sorts, and includes to shape the result set.
- [Create jet stream user](https://api.contractorscloud.com/docs/api-reference/jet-stream-users/create-jet-stream-user.md): Adds a user as a recipient participant of the jet stream and returns the created resource. The added user isn't notified.
- [Get jet stream user](https://api.contractorscloud.com/docs/api-reference/jet-stream-users/get-jet-stream-user.md): Returns a single jet stream participant by id. Returns `404` if the participant doesn't exist or doesn't belong to this stream.
- [Update jet stream user](https://api.contractorscloud.com/docs/api-reference/jet-stream-users/update-jet-stream-user.md): Updates whether a participant has archived the jet stream — the only field that can be changed after creation.
- [Delete jet stream user](https://api.contractorscloud.com/docs/api-reference/jet-stream-users/delete-jet-stream-user.md): Removes a participant from the jet stream. Replies the participant already posted aren't removed.
- [List jet stream replies](https://api.contractorscloud.com/docs/api-reference/jet-stream-replies/list-jet-stream-replies.md): Returns a paginated list of a jet stream's replies. Use filters and includes to shape the result set.
- [Create jet stream reply](https://api.contractorscloud.com/docs/api-reference/jet-stream-replies/create-jet-stream-reply.md): Adds a reply to a jet stream and returns the created resource.
- [Get jet stream reply](https://api.contractorscloud.com/docs/api-reference/jet-stream-replies/get-jet-stream-reply.md): Returns a single jet stream reply by id. Returns `404` if the reply doesn't exist or doesn't belong to this stream.
- [Update jet stream reply](https://api.contractorscloud.com/docs/api-reference/jet-stream-replies/update-jet-stream-reply.md): Updates a reply's text. Only the fields you send are changed, and only the reply's author can update it — anyone else receives a `403`. This doesn't re-notify the stream's participants.
- [Delete jet stream reply](https://api.contractorscloud.com/docs/api-reference/jet-stream-replies/delete-jet-stream-reply.md): Deletes a jet stream reply. The reply's author, the stream's creator, or a user with permission to delete any reply can delete it — anyone else receives a `403`.
- [List suppliers](https://api.contractorscloud.com/docs/api-reference/suppliers/list-suppliers.md): Returns a paginated list of the suppliers configured in your organization, used to track where materials for a project or work order were purchased. Use filters and sorts to shape the result set.
- [Get supplier](https://api.contractorscloud.com/docs/api-reference/suppliers/get-supplier.md): Returns a single supplier by id.
- [List crews](https://api.contractorscloud.com/docs/api-reference/crews/list-crews.md): Returns a paginated list of the crews configured in your organization, used to assign installer or subcontractor work to work orders. Use filters and sorts to shape the result set.
- [Get crew](https://api.contractorscloud.com/docs/api-reference/crews/get-crew.md): Returns a single crew by id.
- [List webhooks](https://api.contractorscloud.com/docs/api-reference/webhooks/list-webhooks.md): Returns a paginated list of webhooks in your organization. Use filters, sorts, and includes to shape the result set.
- [Create webhook](https://api.contractorscloud.com/docs/api-reference/webhooks/create-webhook.md): Creates a webhook and returns the created resource, including its `signing_secret`. Save the secret when you create the webhook — it's returned on every response for this webhook, but there's no separate way to retrieve or rotate it; to change it, delete this webhook and create a new one.
- [Get webhook](https://api.contractorscloud.com/docs/api-reference/webhooks/get-webhook.md): Returns a single webhook by id, including its `signing_secret`.
- [Update webhook](https://api.contractorscloud.com/docs/api-reference/webhooks/update-webhook.md): Updates an existing webhook. Only the fields you send are changed; `endpoint` cannot be set to an empty value if included.
- [Delete webhook](https://api.contractorscloud.com/docs/api-reference/webhooks/delete-webhook.md): Permanently deletes a webhook, along with all of its event subscriptions and its entire delivery history. This cannot be undone.
- [List subscribable events](https://api.contractorscloud.com/docs/api-reference/webhooks/list-subscribable-events.md): Returns every event a webhook can subscribe to. This is the authoritative, current catalog — check it instead of hardcoding event names, since new events may be added over time.
- [List webhook events](https://api.contractorscloud.com/docs/api-reference/webhook-events/list-webhook-events.md): Returns a paginated list of the events a webhook is subscribed to. Use filters, sorts, and includes to shape the result set.
- [Create webhook event](https://api.contractorscloud.com/docs/api-reference/webhook-events/create-webhook-event.md): Subscribes a webhook to an event. `event` must be one of the names returned by [List subscribable events](/api-reference/webhooks/list-subscribable-events), and a webhook can only subscribe to the same event once.
- [Get webhook event](https://api.contractorscloud.com/docs/api-reference/webhook-events/get-webhook-event.md): Returns a single webhook event by id.
- [Update webhook event](https://api.contractorscloud.com/docs/api-reference/webhook-events/update-webhook-event.md): Changes the event this subscription listens for. `event`, if sent, must be one of the names returned by [List subscribable events](/api-reference/webhooks/list-subscribable-events), and a webhook can only subscribe to the same event once.
- [Delete webhook event](https://api.contractorscloud.com/docs/api-reference/webhook-events/delete-webhook-event.md): Permanently unsubscribes the webhook from this event. This cannot be undone, and deliveries for this event stop immediately.
- [List webhook sends](https://api.contractorscloud.com/docs/api-reference/webhook-sends/list-webhook-sends.md): Returns a paginated list of delivery attempts for a webhook, including the exact request body sent and the response received for each. Send records are read-only — there's no update or delete endpoint — and are retained for 365 days. Use filters, sorts, and includes to shape the result set.
- [Send test webhook](https://api.contractorscloud.com/docs/api-reference/webhook-sends/send-test-webhook.md): Synchronously delivers a `webhooks.test` event to this webhook's endpoint and returns the resulting send record. Takes no request body, and works even when the webhook is disabled or has no event subscriptions — a convenient way to verify your endpoint and signature verification before subscribing t…
- [Get webhook send](https://api.contractorscloud.com/docs/api-reference/webhook-sends/get-webhook-send.md): Returns a single webhook send by id, including the exact request body sent and the response received.
- [Search](https://api.contractorscloud.com/docs/api-reference/search/search.md): 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.
- [List available options](https://api.contractorscloud.com/docs/api-reference/meta/list-available-options.md): 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, i…
- [Get API status](https://api.contractorscloud.com/docs/api-reference/meta/get-api-status.md): 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.…
- [Webhooks](https://api.contractorscloud.com/docs/guides/webhooks.md): Receive real-time notifications at your own endpoint whenever data changes in Contractors Cloud.
- [Connect your AI agent](https://api.contractorscloud.com/docs/guides/connect-your-ai-agent.md): Let Claude, ChatGPT, or another AI agent work with your Contractors Cloud account through MCP.
- [OAuth](https://api.contractorscloud.com/docs/guides/oauth.md): Connect an application or AI agent to a user's Contractors Cloud account with OAuth 2.0 and PKCE.
- [Extended properties](https://api.contractorscloud.com/docs/guides/extended-properties.md): Attach and search custom key/value metadata on supported resources.
- [Leads](https://api.contractorscloud.com/docs/guides/leads.md): Receive inbound leads through lead connections and convert them into projects.
- [Creating a project](https://api.contractorscloud.com/docs/guides/examples/creating-a-project.md): Gather the required ids from other endpoints, then create a project in one request.
- [Searching contacts](https://api.contractorscloud.com/docs/guides/examples/searching-contacts.md): Search, sort, paginate, and embed the owner in a single contacts request.
- [Types overview](https://api.contractorscloud.com/docs/types/overview.md): How to read the object definitions returned by the Contractors Cloud API.
- [Project](https://api.contractorscloud.com/docs/types/project.md): The central job record in Contractors Cloud.
- [Project File](https://api.contractorscloud.com/docs/types/project-file.md): A file or photo attached to a project.
- [Project Note](https://api.contractorscloud.com/docs/types/project-note.md): A comment or system-generated activity entry on a project.
- [Album](https://api.contractorscloud.com/docs/types/album.md): A photo album attached to a project.
- [Album Item](https://api.contractorscloud.com/docs/types/album-item.md): A photo placed in a project album.
- [Project Custom Field](https://api.contractorscloud.com/docs/types/project-custom-field.md): A value a project has set for one of its company's custom fields.
- [Claim](https://api.contractorscloud.com/docs/types/claim.md): An insurance claim tracked on a project.
- [Permit](https://api.contractorscloud.com/docs/types/permit.md): A permit tracked on a project.
- [Contract](https://api.contractorscloud.com/docs/types/contract.md): A contract recorded on a project.
- [Invoice](https://api.contractorscloud.com/docs/types/invoice.md): An invoice billed against a project contract.
- [Work Order](https://api.contractorscloud.com/docs/types/work-order.md): A work order scheduled on a project.
- [Material Order](https://api.contractorscloud.com/docs/types/material-order.md): A material order placed for a project work order.
- [Account](https://api.contractorscloud.com/docs/types/account.md): A customer account in your organization.
- [Account Note](https://api.contractorscloud.com/docs/types/account-note.md): A comment or system-generated activity entry on an account.
- [Contact](https://api.contractorscloud.com/docs/types/contact.md): A person or business your organization works with.
- [Contact Note](https://api.contractorscloud.com/docs/types/contact-note.md): A comment or system-generated activity entry on a contact.
- [Linked Contact](https://api.contractorscloud.com/docs/types/linked-contact.md): The link between a contact and the project or account it's linked to.
- [Lead](https://api.contractorscloud.com/docs/types/lead.md): An inbound lead submitted through a lead connection.
- [Lead connection](https://api.contractorscloud.com/docs/types/lead-connection.md): An inbound channel that submits leads into Contractors Cloud.
- [Lead field map](https://api.contractorscloud.com/docs/types/lead-field-map.md): Maps a field in your submitted lead data to a Contractors Cloud field.
- [Lead rep assignment](https://api.contractorscloud.com/docs/types/lead-rep-assignment.md): A rep included in a lead connection's round-robin rotation.
- [Company](https://api.contractorscloud.com/docs/types/company.md): A company in your organization.
- [Company Appointment Type](https://api.contractorscloud.com/docs/types/company-appointment-type.md): An appointment type configured for a company, used when scheduling appointments.
- [Company Custom Field](https://api.contractorscloud.com/docs/types/company-custom-field.md): A custom field definition configured for a company's projects.
- [Company Role](https://api.contractorscloud.com/docs/types/company-role.md): A role configured for a company, used to designate responsibilities.
- [Event](https://api.contractorscloud.com/docs/types/event.md): A company event used to track where a project came from.
- [Lead Source](https://api.contractorscloud.com/docs/types/lead-source.md): Where a project or inbound lead originated.
- [Milestone](https://api.contractorscloud.com/docs/types/milestone.md): A stage within a company's workflow.
- [Workflow](https://api.contractorscloud.com/docs/types/workflow.md): A project workflow configured for a company.
- [User](https://api.contractorscloud.com/docs/types/user.md): A member of your organization with access to Contractors Cloud.
- [Team](https://api.contractorscloud.com/docs/types/team.md): A group of users in your organization, used to organize members and assign work.
- [Team Member](https://api.contractorscloud.com/docs/types/team-member.md): A user's membership on a team.
- [Team Company](https://api.contractorscloud.com/docs/types/team-company.md): A company assigned to a team.
- [Team Note](https://api.contractorscloud.com/docs/types/team-note.md): A system-generated activity log entry for a team.
- [Appointment](https://api.contractorscloud.com/docs/types/appointment.md): A scheduled meeting, optionally linked to a project.
- [Appointment Attendee](https://api.contractorscloud.com/docs/types/appointment-attendee.md): A person invited to an appointment.
- [Task](https://api.contractorscloud.com/docs/types/task.md): A to-do that can be assigned to a user or a team.
- [Task Note](https://api.contractorscloud.com/docs/types/task-note.md): A comment or system-generated activity entry on a task.
- [Jet Stream](https://api.contractorscloud.com/docs/types/jet-stream.md): A threaded activity stream that loops a set of users into updates on a topic.
- [Jet Stream User](https://api.contractorscloud.com/docs/types/jet-stream-user.md): A participant subscribed to a jet stream.
- [Jet Stream Reply](https://api.contractorscloud.com/docs/types/jet-stream-reply.md): A single message posted to a jet stream.
- [Supplier](https://api.contractorscloud.com/docs/types/supplier.md): A supplier configured in your organization.
- [Crew](https://api.contractorscloud.com/docs/types/crew.md): A crew configured in your organization.
- [Webhook](https://api.contractorscloud.com/docs/types/webhook.md): An endpoint that receives event notifications from Contractors Cloud.
- [Webhook event](https://api.contractorscloud.com/docs/types/webhook-event.md): A single event a webhook is subscribed to.
- [Webhook send](https://api.contractorscloud.com/docs/types/webhook-send.md): A record of one delivery attempt for a webhook.
- [Available Option](https://api.contractorscloud.com/docs/types/available-option.md): A reference data value used across other endpoints, such as a project status or appointment result.
- [Pagination](https://api.contractorscloud.com/docs/types/pagination.md): The envelope returned by every list endpoint.
- [Error](https://api.contractorscloud.com/docs/types/error.md): The body of a generic error response.
- [Validation error](https://api.contractorscloud.com/docs/types/validation-error.md): The 422 response body returned when a payload fails validation.

## OpenAPI Specs

- [openapi](/docs/openapi.yaml)

## Optional

- [Blog](https://contractorscloud.com/blog/)
- [Status](https://status.contractorscloud.com/)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.