CRM Object
GET
/api/v1/workspaces/{workspaceId}/crm/{objectSlug}
Scope crm:read
Read one CRM object type by slug, including its primary display properties.
Pfad
objectSlugPflicht
string
CRM object slug, for example contact.
workspaceIdPflicht
string
Workspace that owns the resource.
Antworten
200CrmObjectDefinitionDtoThe request succeeded. The JSON body contains url, data, and meta. The linked schema is data.
CRM object definition.
id
string (uuid)
Identifier.
namePflicht
string
Display name.
slugPflicht
string
Stable slug used in paths and API calls.
description
string
Description shown with this item.
primaryPropertySlug
string
Primary property slug.
displayPropertySlug
string
Display property slug.
secondaryPropertySlug
string
Secondary property slug.
propertiesCount
integer (int32)
Number of properties.
recordsCount
integer (int32)
Number of records.
isSystemDefined
boolean
Whether system defined is set.
systemObjectKind