API Data Provider - Online Help

Gorgias Tables

The provider models the data in API into a list of tables that can be queried using standard SQL statements.

Generally, querying API tables is the same as querying a table in a relational database. Sometimes there are special cases, for example, including a certain column in the WHERE clause might be required to get data for certain columns in the table. This is typically needed for situations where a separate request must be made for each row to get certain columns. These types of situations are clearly documented at the top of the table page linked below.

Gorgias Tables

Name Description
Account Retrieve your account information
Customers Get all customers of the account
Events Get all events of the account of the user
Integrations Get the list of all integrations (active or not) of the current account
Jobs Retrieve a list of jobs
Macros Get all macros of the account
Rules Fetch all the rules of the current account
SatisfactionSurveys Get all satisfaction surveys
Teams Get all teams of the account
TicketEvents Retrieve a list of events associated to the given ticket id.
TicketMessages Retrieve a list of messages associated to the given ticket id.
Tickets Retrieve a list of tickets
UserAuditLogs Retrieve all users' activity on the helpdesk
UserAuths Retrieve a list of auths
Users Retrieve all users of the account of the current user
UserTickets Get all tickets of the specified user
Views Get all views of the account

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8487.0