v1

latestOpenAPI 3.1.02026-07-24770322.0 KB

List Custom Fields

This API endpoint retrieves a list of all the custom fields that have been created in your workspace.

get/v1/custom-fields

Query parameters

entityTypestring

Only return custom fields that have an entity type matching this value. Can be one of client or company.

Response

200

Example response

{
  "data": [
    {
      "id": "de0ad982-a5a2-437b-94ce-99643a816ba0",
      "key": "nickname",
      "name": "Nickname",
      "type": "text",
      "order": 2,
      "object": "customField"
    }
  ]
}