PEperk
Custom fields

List all select options

get/custom-fields/{custom_field_id}/select-options

Request

  • Base URL
    https://api.perk.com
  • URL
    https://api.perk.com/custom-fields/{custom_field_id}/select-options
  • Auth
    none declared. Required headers: Authorization, Api-Version

Path parameters

custom_field_idstring required

The unique ID of the custom field

Query parameters

limitinteger

The number of options to return, from 1 to 100. Defaults to 20.

offsetinteger

The number of options to skip before returning results. Defaults to 0.

querystring

Filters options to those whose value contains this substring.

statusstring

Comma-separated list of statuses to include. Accepts 'active' and 'archived'. Defaults to 'active'.

Headers

Authorizationstring required

Your Perk API key, using the format 'ApiKey <your_api_key>'

Api-Versionstring required

The API version for this request. Must be '1'.

Response

Returns 200 OK and a list of select options for the custom field, along with total_count, limit and offset

total_countinteger

Total number of options matching the filter, across all pages

limitinteger

Effective page size used (echoes the request's limit, default 20)

offsetinteger

Effective offset used (echoes the request's offset, default 0)

Changes

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