Skip to Content
Z8Z8 Docs

List customer custom fields

GET
/api/v1/customers/custom-fields

The organization's custom fields for customers, active and archived, ordered by position. Each of its customers carries their values in customFields, keyed by field id.

Without the key scope custom-fields:read-restricted, fields only managers or admins see are left out, names included.

Requires the key scope customers:read.

Authorization

apiKey
headerAuthorizationBearer <token>

An organization API key (starts with z8_org).

Query Parameters

limit?integer

Rows per page, 1 to 200.

Range1 <= value <= 200
Default50
cursor?string

The nextCursor of the previous page. Omit it for the first page.

Length1 <= length <= 1024
status?string

Only fields with this status. Both by default.

Value in"active""archived"

Response Body

OK

application/json
  1. response
data*array<>
nextCursor*|

Pass as cursor to read the next page; null on the last page.

Example Request
curl -X GET 'https://ui.z8-time.app/api/v1/customers/custom-fields'
Example Response
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "type": "text",      "tracked": true,      "required": true,      "visibility": "admin",      "archived": true,      "position": -9007199254740991,      "integerOnly": true,      "min": "string",      "max": "string",      "options": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "label": "string",          "archived": true        }      ]    }  ],  "nextCursor": "string"}