List custom events

Lists the custom events on your instance, one page at a time.

GET /settings/custom_events

cURL

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/settings/custom_events?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>",
      "base_event": true,
      "created_on": "<string>",
      "last_updated_on": "<string>",
      "created_by": "<unknown>",
      "last_updated_by": "<unknown>",
      "href": "<string>"
    }
  ],
  "pagination": {
    "limit": 123,
    "has_more": true,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    }
  }
}

Returns a page of custom events under data, with cursor pagination. Other fields filter as filter_<field> for equality or filter_<field>_<operator>, such as filter_created_on_gte.

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 pagination.next_cursor of the previous page, to read the page after it.

sort · string

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

Example:

"-created_on"

Response

200 - application/json

A page of custom events.

object · string

Always list.

url · string

The path this page was read from.

data · object[]

Show child attributes

pagination · object

Show child attributes