schema

Describe the CRM model, pipelines, custom fields, limits, and starter models

Describe the CRM: object types and whether they can be extended, pipelines and stages, custom fields, tags, your own capabilities, the workspace timezone and default currency, ID prefixes, every stated limit, every error code, and the derived values the database computes on read and nothing can write. Call this first; it removes the need to probe.

get/v1/schema

Request

  • Base URL: https://api.indraft.io
  • URL: https://api.indraft.io/v1/schema
  • Auth: HTTP bearer

Query parameters

starterModelstring

The key of one starter model to return in full. Absent returns only the summaries, which is enough to choose or to decide none of them fits. A key nobody defined is not an error.

Response

Success

requestIdstring required

Changes

No recorded changes to this operation across all 1 revision of this API.