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.

Query Parameters:

• page - Page number
• perPage - Items per page
• type - Filter by type (DOCUMENT or CONTACT)

GET /api/v1/custom-fields

List all custom fields

cURL

curl --request GET \
  --url https://app.sajn.se/api/v1/custom-fields \
  --header 'authorization: <authorization>'

200

{
  "customFields": [
    {
      "id": "<string>",
      "name": "<string>",
      "type": "DOCUMENT",
      "inputType": "TEXT",
      "defaultValue": "<string>",
      "required": true,
      "options": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "totalPages": 123
}

Headers

authorization · string · required

Bearer token for API authentication

Query Parameters

Response

200

application/json

200

customFields · object[] · required

Show child attributes

totalPages · number · required