List custom fields

Returns one page of the custom fields in your settings.

GET /settings/custom_fields

cURL

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/settings/custom_fields?limit=20" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

200

{
  "object": "<string>",
  "url": "<string>",
  "data": [
    {
      "object": "<string>",
      "id": "<string>",
      "status": "<string>",
      "name": "<string>",
      "display_name": "<string>",
      "description": "<string>",
      "type": "<string>",
      "is_mandatory": true,
      "created_on": "<string>",
      "last_updated_on": "<string>",
      "created_by": "<unknown>",
      "last_updated_by": "<unknown>",
      "version": 123,
      "href": "<string>"
    }
  ],
  "pagination": {
    "limit": 123,
    "has_more": true,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    }
  }
}

Lists the custom fields with each one’s name, type and whether it is mandatory. Records are under data and paging details under pagination. Fields filter as filter_<field>.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization · string · header · required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Query Parameters

limit · integer

The most records to return on one page.

Example:

20

cursor · string

The next_cursor from the previous page, to read the page after it.

sort · string

A field to sort by, such as created_on, or -created_on for newest first.

Example:

"-created_on"

Response

200 - application/json

One page of custom fields, under data.

object · string

url · string

data · object[]

Show child attributes

pagination · object

Show child attributes