Skip to content

Event Types

Event types are a simple enumerable, read-only resource, meant to indicate event types. There is a limited number of event types, so there is no support for pagination or search.

The result for this endpoint will rarely change, so you may cache it. However, the result is not guaranteed to be identical between our QA and production environments.

Attributes

id

int readonly

Internal ID, used to retrieve this record and as identifier in relationships from other records.

title

string readonly

A descriptive title for this event type.

Endpoints

List

HTTP
GET /channels/event-types
Authorization: Channel <Api Key>
X-Channel: <Channel Identifier>
JSON
{
    "requestId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "status": 200,
    "data": [
        {
            "id": 1,
            "title": "Some Event Type"
        }
    ]
}

Get

HTTP
GET /channels/event-types/{id}
Content-Type: application/json
Authorization: Channel <Api Key>
X-Channel: <Channel Identifier>
JSON
{
    "requestId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "status": 200,
    "data": [
        {
            "id": 1,
            "title": "Some Event Type"
        }
    ]
}