Get segment fields

Return every field you can filter on in a segment query, grouped by entity, with its type, label and allowed operators. Includes your organization's custom fields, tags, team members and conversation events. Nothing is saved.

Endpoint

POST
/contacts-segments-schema-builder

Body

NameTypeRequiredDescription
organization_idintegerYesYour API key's organization ID.

Request

Response

json

Use the group key as a condition's entity and the field key as its field. For custom fields (isCustomField: true) send isCustomField and customFieldId instead of field. Some fields include options (tags, users, select values).

Errors

StatusWhen
403organization_id is not your API key's organization.
500organization_id is missing or the organization does not exist.

Report an issue with this documentation

Please log in to report issues with our documentation.