List events

get

https://{domain}.gorgias.com/api/events

List events, paginated, and ordered by their creation date, with the most recently created first.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

created_datetime

object

Comparators used to filter events on their creation date.

cursor

string

Value indicating your position in the list of all events. If omitted, the first events of the list will be returned.

limit

integer

1 to 100

Defaults to 30

Maximum number of events to return.

object_id

integer

ID of the object associated with the events to return.

object_type

string

enum

Type of the object associated with the events to return.

order_by

string

enum

Defaults to created_datetime:desc

Attribute used to order events.
Value of <span style={{color: 'red'}}>created_datetime has been deprecated, use created_datetime:asc or created_datetime:desc instead.

Allowed:

types

array of strings

Types of the events to return.

types

user_ids

array of integers

length ≤ 1

IDs of the users who triggered the events to return.

user_ids

Response

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A list of events.