List Custom Fields
GET/api/custom-fields
Returns a paginated list of custom fields. Custom fields can be attached to different entity types (link_type).
Authentication: Requires Bearer token.
Query parameters:
- page — Page number (default: 1)
- limit — Results per page (default: 15)
- search — Full-text search by name
- sort — Sort field, prefix with - for descending
- archived — 0 = active, 1 = archived (soft-deleted)
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
Content-Type
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.