v1

latestOpenAPI 3.1.02026-08-065163115.0 KB

Custom Fields

List custom fields

Returns a paginated list of custom fields for the given business.

get/v1/businesses/{client_id}/custom-fields

Path parameters

client_idinteger required

Example:123

The ID of the business.

Query parameters

offsetinteger

Example:50

Offset to retrieve items from.

limitinteger

Example:50

Number of items per page.

Response

countinteger

Total number of custom fields.

nextstring nullable

Pagination cursor for the next page.

previousstring nullable

Pagination cursor for the previous page.

Example response

{
  "count": 10,
  "next": "limit=50&offset=50",
  "results": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Project Code",
      "field_type": "LIST",
      "budget_setting": "NONE",
      "created_by": "PUBLIC_API",
      "created": "2024-01-15T09:00:00Z",
      "updated": "2024-01-15T09:00:00Z"
    }
  ]
}