Docs

Get Collaborator Properties

GET /organizations/{organizationId}/collaborator-properties

GET/organizations/{organizationId}/collaborator-properties

Required Tokens

FieldTypeRequiredDescription
BearerAuthorization: Bearer <api-key>OptionalYour API key. Pass it as the Bearer token on every request.
Organization tokenx-Organization-TokenOptionalRun **Authorize Organization** in the Authorization folder.

Returns all collaborator properties for the organization, including archived properties. Properties are the reusable field definitions that can be assigned to collaborator types.

Requires OrganizationAdmin permission.

Path Parameters

FieldTypeRequiredDescription
organizationIdGuidRequiredThe organization to list properties for.

Response

FieldTypeDescription
idGuidProperty ID.
namestringDisplay name.
typestringProperty type: `Text`, `Select`, `Number`, `Date`, `Checkbox`, or `Link`.
isArchivedboolWhether the property is archived.
optionsarray| nullAvailable options (Select properties only).

Options

FieldTypeDescription
labelstringOption display label.