List custom fields

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

Security

BearerAuth

client_idintegerrequired

The ID of the business.

Example:123

offsetinteger

Offset to retrieve items from.

Default:0

Example:offset=50

limitinteger, <= 500

Number of items per page.

Default:50

Example:limit=50

GET

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

curl -i -X GET \
  'https://public.letsweel.com/v1/businesses/123/custom-fields?offset=50&limit=50' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

OK

Bodyapplication/json

countinteger

Total number of custom fields.

Example:10

nextstring or null

Pagination cursor for the next page.

Example:"limit=50&offset=50"

previousstring or null

Pagination cursor for the previous page.

Example:null

resultsArray of objects(CustomField)

Response

{
  "count": 10,
  "next": "limit=50&offset=50",
  "previous": null,
  "results": [
    { … }
  ]
}