younifyd
Menu

List Events

List events

GET/api/events

Use it in a workflow

  1. Add a step and choose the Gorgias connector.
  2. Pick the List Events action (under Events).
  3. Fill in the fields below, then reference the result from later steps as {{listEvents.response.data}}.

Request

Query parameters

created_datetimeobject

Comparators used to filter events on their creation date.

ltstring (date-time)

Less than the given value.

ltestring (date-time)

Less than or equal to the given value.

gtstring (date-time)

Greater than then given value.

gtestring (date-time)

Greater than or equal to the given value.

cursorstring

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

limitinteger

Maximum number of events to return.

Default 30

object_idinteger

ID of the object associated with the events to return.

object_typestring

Type of the object associated with the events to return.

One ofAccountAccountSettingMacroTagCustomerTeamViewWidgetCustomFieldCustomFieldConditionUserTicketMessageTicketRuleIntegrationSatisfactionSurvey

order_bystring

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

One ofcreated_datetimecreated_datetime:asccreated_datetime:descDefault "created_datetime:desc"

typesarray<string>

Types of the events to return.

user_idsarray<integer>

IDs of the users who triggered the events to return.

Response

Returns 200 with a array<object>. Read it in later steps with {{listEvents.response.data.<field>}}.

Need more? See the Gorgias guide for connection setup and behaviour shared by every action.

Was this page helpful?