CRM Object
GET
/api/v1/workspaces/{workspaceId}/crm/{objectSlug}/properties
Scope crm:read
List the property definitions of one CRM object type. Archived properties are omitted unless includeArchived is true.
Pfad
objectSlugPflicht
string
CRM object slug, for example contact.
workspaceIdPflicht
string
Workspace that owns the resource.
Query
includeArchived
boolean
When true, include archived items.
Antworten
200CrmObjectPropertyDefinitionDto[]The 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.