Data API
Search
The five Data API request shapes. POST search, GET by id, GET related records, and field discovery.
The Data API has five request shapes. All are read-only.
| Shape | Method + Path | Purpose |
|---|---|---|
| Search records | POST /data/{dataset}/search | Full-text search, filter, sort, and paginate a dataset. |
| Get a record | GET /data/{dataset}/{id} | Fetch one record by UUID. |
| Related records | GET /data/{dataset}/{id}?include=... | Embed related dataset records in a single response. |
| Search fields | POST /data/fields/search | Discover filterable fields, enum values, and relational sub-fields for a dataset. 0 credits. |
| Get fields | GET /data/fields/{dataset}/{key} | Fetch one field descriptor by key. 0 credits. |
For the first three shapes, {dataset} is one of accounts, contacts, projects, or signals. The fields shapes use a broader {dataset} that also includes workspace_accounts, workspace_projects, and workspace_contacts; see Search Fields for the full list.
Search RecordsPOST body reference: query, filters, sort, limit, offset.Get a RecordFetch one record by UUID. Returns 404 if no record with that UUID exists.Related RecordsEmbed related records using the include parameter on a GET by id request.Search FieldsDiscover filterable fields, enum values, and relational sub-fields. 0 credits.Get FieldsFetch one field descriptor by key. Returns 404 if the dataset or key is unknown.