UPupflow
Custom Fields

List Custom Fields

List custom fields with optional pagination.

get/custom_fields

Request

  • Base URL
    https://api.upflow.io/v1
  • Auth
    API key in header X-Api-Key and API key in header X-Api-Secret

Query parameters

offsetinteger

The 0-based index of the first item to return.

pageinteger
Example:1

The page number to retrieve (1-based). If both page and offset are provided, offset takes priority.

limitinteger
Example:100

Maximum number of items to return per page.

Response

Paginated list of custom fields.

offsetinteger

0-based index of the first item returned. Returned when using offset-based pagination or by default.

pageinteger

Page number (1-based). Returned when using page-based pagination.

limitinteger required

Maximum number of items returned.

totalinteger required

Total items in the set.

Example response

{
  "page": 1,
  "limit": 50,
  "total": 100,
  "items": [
    {
      "externalId": "AEGaaZD",
      "label": "custom field 01",
      "description": "custom field 01 description",
      "id": "00a70b35-2be3-4c43-aefb-397190134655",
      "source": "USER_DEFINED"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.