API Reference Overview

In Progress
The API documentation is currently being written. Links are included to partially or fully completed documentation.
The following is a table of contents for the API reference documentation.

API object structures: The objects returned by the various API methods
API enumerations: The fixed values of various object statuses, types, and so forth
API method categories: See table, below.
Topic
Subtopic
API path
Notes
Agents

/agents

Agents are your employees; they write articles, field chats and phone calls, and manage tickets. Note that agents also have user records; user-related management is performed using the Users API
Agents
Custom Fields
/agents/fields

Custom fields to filter and locate agents; these are in addition to the agent's user record custom fields.
Agents
Groups
/groups

Used for assigning agents by language, skill, and so forth; unlike teams and locations, an agent can belong to multiple groups.
Agents
Locations
/locations

Used for assigning agents to a working location; unlike groups, an agent can be assigned to only one location.
Agents
Teams
/teams

Used for assigning agents to a working group; unlike groups, an agent can be assigned to only one team.
Articles

/articles

Articles are pages of information for customers, but can also be feature request or known issue pages.
Articles
Categories
/categories

Used to organize articles. You can create categories and one level of subcategories.
Articles
Filters
/savedFilters

Used by agents to quickly locate relevant tickets.
Articles
Labels
/labels

Used to organize, locate, or hide/display articles and tickets.
Phones
Lines
/callcenter/lines
Phones
Queues
/callcenter/queues
Tickets

/tickets

Tickets represent threads of communication with users, typically starting with a phone call or chat with the user; they can reference related articles and be assigned to agents or groups.
Tickets
Custom Fields
/tickets/fields

Custom fields to filter and locate tickets.
Tickets
Labels
/labels

Used to organize, locate, or hide/display articles and tickets.
Tickets
Replies
/replies

Replies by the agent or user to the original ticket; see also Tickets.
Tickets
Saved Replies
/savedReplies

Preset replies that agents can use to reply to tickets.
Users

/users

Users read articles, and create tickets when they initiate contact with agents.
Users
Companies
/companies

Used to organize users.
Users
Company Custom Fields
/companies/fields

Custom fields to filter and locate companies.
Users
Custom Fields
/users/fields

Custom fields to filter and locate users.