List field settings

Returns a page of field settings under data, with paging details under pagination.

GET /settings/field_settings

cURL

cURL

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

200

{
  "data": [
    {
      "created_by": "<unknown>",
      "created_on": "<string>",
      "description": "<unknown>",
      "display_code": "<string>",
      "editable": "<unknown>",
      "enabled": true,
      "entity": "<string>",
      "field_name": "<string>",
      "field_type": "<string>",
      "global_search": true,
      "group_key": "<string>",
      "href": "<string>",
      "id": "<string>",
      "last_updated_by": "<unknown>",
      "last_updated_on": "<string>",
      "mandatory": true,
      "note": "<unknown>",
      "object": "<string>",
      "sort_order": 123
    }
  ],
  "object": "<string>",
  "pagination": {
    "limit": 123,
    "has_more": true,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    }
  },
  "url": "<string>"
}

Lists the field settings on the instance. Each field setting names an entity, such as ACCOUNT or ITEM, a field_name, and whether it is enabled and mandatory. Pass limit to set the page size, and while pagination.has_more is true pass pagination.next_cursor back as cursor to read the next page. Other fields filter as filter_<field> or filter_<field>_<operator>, and sort orders the results. include_total=true is refused.

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

How many records to return on one page.

Example:

20

cursor · string

The pagination.next_cursor of the previous page, to read the next one.

sort · string

The field to sort by. Prefix it with - for descending order, such as -created_on.

Example:

"-created_on"

Response

200 - application/json

A page of field settings, under data.

data · object[]

Show child attributes

object · string

pagination · object

Show child attributes

url · string