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.

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
  Read the caller's capabilities/api/v1/capabilities
• POST
  Install the standard objects/api/v1/bootstrap
• GET
  List objects/api/v1/objects
• POST
  Create a custom object/api/v1/objects
• PATCH
  Rename an object/api/v1/objects/{objectId}
• GET
  List an object's fields/api/v1/objects/{objectId}/fields
• POST
  Add a field/api/v1/objects/{objectId}/fields
• PATCH
  Change a field/api/v1/objects/{objectId}/fields/{fieldId}
• GET
  List related objects/api/v1/objects/{objectId}/related
• GET
  List an object's records/api/v1/objects/{objectId}/records
• POST
  Create a record/api/v1/objects/{objectId}/records
• GET
  Read a record/api/v1/objects/{objectId}/records/{recordId}
• DELETE
  Archive a record/api/v1/objects/{objectId}/records/{recordId}
• PUT
  Update a record/api/v1/objects/{objectId}/records/{recordId}
• GET
  Find conversion matches/api/v1/objects/{objectId}/records/{recordId}/conversion-matches
• POST
  Convert a lead/api/v1/objects/{objectId}/records/{recordId}/actions/convert
• POST
  Revert a conversion/api/v1/objects/{objectId}/records/{recordId}/actions/revert-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
  Read the commercial policy/api/v1/settings/commercial
• PUT
  Save the commercial policy/api/v1/settings/commercial
• GET
  List products/api/v1/products
• POST
  Create a product/api/v1/products
• GET
  List price books/api/v1/price-books
• POST
  Create a price book/api/v1/price-books
• POST
  Create a price agreement/api/v1/price-agreements
• POST
  Import price entries/api/v1/price-books/{id}/entries
• GET
  List quotes/api/v1/quotes
• POST
  Create a quote/api/v1/quotes
• POST
  Create a draft quote/api/v1/quotes/drafts
• PUT
  Update a draft quote/api/v1/quotes/{id}/draft
• GET
  Read a quote/api/v1/quotes/{id}
• GET
  Read one version of a quote/api/v1/quotes/{id}/versions/{version}
• POST
  Revise a quote/api/v1/quotes/{id}/versions
• GET
  Read the CPQ profile/api/v1/cpq/configuration
• GET
  List a product's purchase costs/api/v1/products/{id}/purchase-costs
• POST
  Record a purchase cost/api/v1/purchase-costs
• POST
  Preview a quote's pricing/api/v1/quotes/preview

Approvals

Approval definitions, the requests submitted against them, and the decisions and withdrawals that close them. Every endpoint needs the approvals module.

• GET
  List approval definitions/api/v1/approval-definitions
• POST
  Create an approval definition/api/v1/approval-definitions
• GET
  List approval requests/api/v1/approvals
• POST
  Submit a record for approval/api/v1/approvals
• POST
  Decide a stage/api/v1/approvals/{id}/decisions
• GET
  Read a request's decisions/api/v1/approvals/{id}/decisions
• POST
  Withdraw a request/api/v1/approvals/{id}/withdraw

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
  Preview a report definition/api/v1/reports/preview
• GET
  List saved reports/api/v1/reports
• POST
  Save a report/api/v1/reports
• GET
  Run a saved report/api/v1/reports/{id}/results
• GET
  List dashboards/api/v1/dashboards
• POST
  Create a dashboard/api/v1/dashboards
• GET
  Read a dashboard's widgets/api/v1/dashboards/{id}/widgets

Document templates

Document templates and the documents generated from them, including retry and download. Every endpoint needs the documents module.

• GET
  List document templates/api/v1/document-templates
• POST
  Create a document template/api/v1/document-templates
• POST
  Generate a document/api/v1/documents
• GET
  Read a document's status/api/v1/documents/{id}
• POST
  Retry a failed document/api/v1/documents/{id}/retry
• POST
  Issue a download link/api/v1/documents/{id}/download