ChatGPT ↗
Claude ↗This page documents the canonical HTTP contract for this endpoint.
The three optional inclusion flags default to true. Setting include_relationships=false skips related-summary hydration; include_provenance=false removes heavy provenance data; include_custom_fields=false omits both custom field values and their metadata. The response example is abridged; the returned record can include additional fields.
Path parameters
company_idrequiredstring
Company ID.
| Name | Type | Description |
|---|---|---|
| company_idrequired | string | Company ID. |
Query parameters
include_custom_fields· optionalboolean
Include custom fields. Default true.
include_provenance· optionalboolean
Include source provenance. Default true.
include_relationships· optionalboolean
Include related records. Default true.
| Name | Type | Description |
|---|---|---|
| include_custom_fields | boolean | Include custom fields. Default true. |
| include_provenance | boolean | Include source provenance. Default true. |
| include_relationships | boolean | Include related records. Default true. |
Errors
| Status | Meaning |
|---|---|
| 400 | Invalid company ID format or missing organization context. |
| 401 | Invalid API key or missing organization context. |
| 403 | Missing companies:read scope. |
| 404 | Company not found. |