CRM Object
GET
/api/v1/workspaces/{workspaceId}/crm/{objectSlug}/properties/{propertySlug}
Scope crm:read
Read one property definition of a CRM object type by slug.
Pfad
objectSlugPflicht
string
CRM object slug, for example contact.
propertySlugPflicht
string
Property slug on the CRM object.
workspaceIdPflicht
string
Workspace that owns the resource.
Antworten
200CrmObjectPropertyDefinitionDtoThe request succeeded. The JSON body contains url, data, and meta. The linked schema is data.
CRM object property definition.
id
string (uuid)
Identifier.
namePflicht
string
Display name.
description
string
Description shown with this item.
slugPflicht
string
Stable slug used in paths and API calls.
type
template
string
Template.
isRequired
boolean
Whether this is required.
isUnique
boolean
Whether this is unique.
isSensitive
boolean
Whether this is sensitive.
isSystem
boolean
Whether this is system.
isValueSystemManaged
boolean
Whether value system managed is set.
isArchived
boolean
Whether this is archived.
sortOrder
integer (int32)
Order among siblings. Lower numbers come first.
groupId
string (uuid)
Identifier of the group.
groupSlug
string
Group slug.
groupName
string
Name of the group.
options
CrmPropertyOptionDto[]
Options.