List all custom fields
Retrieve a paginated list of custom field definitions.
Custom fields allow you to add additional structured data to documents or contacts.
Filter by type (DOCUMENT or CONTACT). The newest custom fields come first.
Pagination: Pass nextCursor from the previous response as cursor until hasMore is false.
Authorizations
Personal API key, e.g. Authorization: Bearer sajn_sk_.... Not scope-limited — acts as the issuing user.
Headers
API version for this request. Without it, the request uses the organization's default version; an organization without a default is pinned to the latest version by its first request.
2026-09, 2026-10 ID of the workspace this request acts in, from GET /api/v1/workspaces. Without it, an API key acts in its default workspace. The token's user must be a member of the workspace; an OAuth token only accepts the workspace it was granted for. A workspace that doesn't exist or can't be reached returns 403 WORKSPACE_ACCESS_DENIED.
Query Parameters
Maximum number of items to return, from 1 to 100. Default: 25.
1 <= x <= 100The nextCursor from the previous response, to get the next page. Keep the other parameters unchanged.
1 - 2048total adds the number of items that match the filters. Counting takes time, so ask for it only when you need it.
total Returns only custom fields of this type.
DOCUMENT, CONTACT Only custom fields created at or after this ISO 8601 date or date-time.
Only custom fields created at or before this ISO 8601 date or date-time.
Only custom fields updated at or after this ISO 8601 date or date-time. Use it for incremental sync.
Only custom fields updated at or before this ISO 8601 date or date-time.
Response
200
True if more items follow this page.
Pass this as cursor to get the next page. Null on the last page.
The number of items that match the filters. Present only with include=total.
-9007199254740991 <= x <= 9007199254740991
