--- seo: description: >- REST resources for external clients. The signed-in workspace transport under /api/v1/workspace is not part of this API and refuses bearer tokens. sidebar: label: Overview title: Taylorz CRM --- REST resources for external clients. The signed-in workspace transport under /api/v1/workspace is not part of this API and refuses bearer tokens. Version 1 Base URL: `/api/v1` ## Objects and records Objects, their fields, the records in them, and lead conversion. Reading and writing records is core; changing an object or a field needs the custom_objects module. - [`GET /api/v1/capabilities`](/reference/crm/get-api-v1-capabilities) — Read the caller's capabilities. - [`POST /api/v1/bootstrap`](/reference/crm/post-api-v1-bootstrap) — Install the standard objects. - [`GET /api/v1/objects`](/reference/crm/get-api-v1-objects) — List objects. - [`POST /api/v1/objects`](/reference/crm/post-api-v1-objects) — Create a custom object. - [`PATCH /api/v1/objects/{objectId}`](/reference/crm/patch-api-v1-objects-by-object-id) — Rename an object. - [`GET /api/v1/objects/{objectId}/fields`](/reference/crm/get-api-v1-objects-by-object-id-fields) — List an object's fields. - [`POST /api/v1/objects/{objectId}/fields`](/reference/crm/post-api-v1-objects-by-object-id-fields) — Add a field. - [`PATCH /api/v1/objects/{objectId}/fields/{fieldId}`](/reference/crm/patch-api-v1-objects-by-object-id-fields-by-field-id) — Change a field. - [`GET /api/v1/objects/{objectId}/related`](/reference/crm/get-api-v1-objects-by-object-id-related) — List related objects. - [`GET /api/v1/objects/{objectId}/records`](/reference/crm/get-api-v1-objects-by-object-id-records) — List an object's records. - [`POST /api/v1/objects/{objectId}/records`](/reference/crm/post-api-v1-objects-by-object-id-records) — Create a record. - [`GET /api/v1/objects/{objectId}/records/{recordId}`](/reference/crm/get-api-v1-objects-by-object-id-records-by-record-id) — Read a record. - [`DELETE /api/v1/objects/{objectId}/records/{recordId}`](/reference/crm/delete-api-v1-objects-by-object-id-records-by-record-id) — Archive a record. - [`PUT /api/v1/objects/{objectId}/records/{recordId}`](/reference/crm/put-api-v1-objects-by-object-id-records-by-record-id) — Update a record. - [`GET /api/v1/objects/{objectId}/records/{recordId}/conversion-matches`](/reference/crm/get-api-v1-objects-by-object-id-records-by-record-id-conversion-matches) — Find conversion matches. - [`POST /api/v1/objects/{objectId}/records/{recordId}/actions/convert`](/reference/crm/post-api-v1-objects-by-object-id-records-by-record-id-actions-convert) — Convert a lead. - [`POST /api/v1/objects/{objectId}/records/{recordId}/actions/revert-conversion`](/reference/crm/post-api-v1-objects-by-object-id-records-by-record-id-actions-revert-conversion) — Revert a conversion. ## Commerce and CPQ Products, price books, price agreements, purchase costs and quotes, including the draft and version paths. Every endpoint needs the cpq module. - [`GET /api/v1/settings/commercial`](/reference/commerce/get-api-v1-settings-commercial) — Read the commercial policy. - [`PUT /api/v1/settings/commercial`](/reference/commerce/put-api-v1-settings-commercial) — Save the commercial policy. - [`GET /api/v1/products`](/reference/commerce/get-api-v1-products) — List products. - [`POST /api/v1/products`](/reference/commerce/post-api-v1-products) — Create a product. - [`GET /api/v1/price-books`](/reference/commerce/get-api-v1-price-books) — List price books. - [`POST /api/v1/price-books`](/reference/commerce/post-api-v1-price-books) — Create a price book. - [`POST /api/v1/price-agreements`](/reference/commerce/post-api-v1-price-agreements) — Create a price agreement. - [`POST /api/v1/price-books/{id}/entries`](/reference/commerce/post-api-v1-price-books-by-id-entries) — Import price entries. - [`GET /api/v1/quotes`](/reference/commerce/get-api-v1-quotes) — List quotes. - [`POST /api/v1/quotes`](/reference/commerce/post-api-v1-quotes) — Create a quote. - [`POST /api/v1/quotes/drafts`](/reference/commerce/post-api-v1-quotes-drafts) — Create a draft quote. - [`PUT /api/v1/quotes/{id}/draft`](/reference/commerce/put-api-v1-quotes-by-id-draft) — Update a draft quote. - [`GET /api/v1/quotes/{id}`](/reference/commerce/get-api-v1-quotes-by-id) — Read a quote. - [`GET /api/v1/quotes/{id}/versions/{version}`](/reference/commerce/get-api-v1-quotes-by-id-versions-by-version) — Read one version of a quote. - [`POST /api/v1/quotes/{id}/versions`](/reference/commerce/post-api-v1-quotes-by-id-versions) — Revise a quote. - [`GET /api/v1/cpq/configuration`](/reference/commerce/get-api-v1-cpq-configuration) — Read the CPQ profile. - [`GET /api/v1/products/{id}/purchase-costs`](/reference/commerce/get-api-v1-products-by-id-purchase-costs) — List a product's purchase costs. - [`POST /api/v1/purchase-costs`](/reference/commerce/post-api-v1-purchase-costs) — Record a purchase cost. - [`POST /api/v1/quotes/preview`](/reference/commerce/post-api-v1-quotes-preview) — Preview a quote's pricing. ## Approvals Approval definitions, the requests submitted against them, and the decisions and withdrawals that close them. Every endpoint needs the approvals module. - [`GET /api/v1/approval-definitions`](/reference/approvals/get-api-v1-approval-definitions) — List approval definitions. - [`POST /api/v1/approval-definitions`](/reference/approvals/post-api-v1-approval-definitions) — Create an approval definition. - [`GET /api/v1/approvals`](/reference/approvals/get-api-v1-approvals) — List approval requests. - [`POST /api/v1/approvals`](/reference/approvals/post-api-v1-approvals) — Submit a record for approval. - [`POST /api/v1/approvals/{id}/decisions`](/reference/approvals/post-api-v1-approvals-by-id-decisions) — Decide a stage. - [`GET /api/v1/approvals/{id}/decisions`](/reference/approvals/get-api-v1-approvals-by-id-decisions) — Read a request's decisions. - [`POST /api/v1/approvals/{id}/withdraw`](/reference/approvals/post-api-v1-approvals-by-id-withdraw) — Withdraw a request. ## Reports and dashboards Report definitions previewed or saved and run, and the dashboards that arrange saved reports into widgets. Every endpoint needs the reports module. - [`POST /api/v1/reports/preview`](/reference/reports/post-api-v1-reports-preview) — Preview a report definition. - [`GET /api/v1/reports`](/reference/reports/get-api-v1-reports) — List saved reports. - [`POST /api/v1/reports`](/reference/reports/post-api-v1-reports) — Save a report. - [`GET /api/v1/reports/{id}/results`](/reference/reports/get-api-v1-reports-by-id-results) — Run a saved report. - [`GET /api/v1/dashboards`](/reference/reports/get-api-v1-dashboards) — List dashboards. - [`POST /api/v1/dashboards`](/reference/reports/post-api-v1-dashboards) — Create a dashboard. - [`GET /api/v1/dashboards/{id}/widgets`](/reference/reports/get-api-v1-dashboards-by-id-widgets) — Read a dashboard's widgets. ## Document templates Document templates and the documents generated from them, including retry and download. Every endpoint needs the documents module. - [`GET /api/v1/document-templates`](/reference/documents/get-api-v1-document-templates) — List document templates. - [`POST /api/v1/document-templates`](/reference/documents/post-api-v1-document-templates) — Create a document template. - [`POST /api/v1/documents`](/reference/documents/post-api-v1-documents) — Generate a document. - [`GET /api/v1/documents/{id}`](/reference/documents/get-api-v1-documents-by-id) — Read a document's status. - [`POST /api/v1/documents/{id}/retry`](/reference/documents/post-api-v1-documents-by-id-retry) — Retry a failed document. - [`POST /api/v1/documents/{id}/download`](/reference/documents/post-api-v1-documents-by-id-download) — Issue a download link.