List receive terms

Returns one page of receive terms.

GET /settings/receive_terms

cURL

cURL

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

200

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

Lists the receive terms set up on the account, one page at a time, under data. Other fields filter the list as filter_<field> or filter_<field>_<operator>.

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 value from 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

One page of receive terms.

data · object[]

Show child attributes

object · string

pagination · object

Show child attributes

url · string