Sign in

v1

latestOpenAPI 3.1.02026-08-065163115.0 KB
Custom Field Budgets

List budgets linked to a custom field

Returns a paginated list of budgets that have this custom field assigned.

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

Path parameters

client_idinteger required
Example:123

The ID of the business.

custom_field_idstring uuid required
Example:3fa85f64-5717-4562-b3fc-2c963f66afa6

The ID of the custom field.

Query parameters

offsetinteger
Example:50

Offset to retrieve items from.

limitinteger
Example:50

Number of items per page.

Response

OK

countinteger

Total number of budgets linked to this custom field.

nextstring nullable

Pagination cursor for the next page.

previousstring nullable

Pagination cursor for the previous page.

Example response

{
  "count": 3,
  "next": "limit=50&offset=50",
  "results": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Marketing Q1"
    }
  ]
}