Skip to main content
New to Corsair? See API access, authentication, and error handling.

Agents

get

agents.get Get an agent, optionally with its profile, role, departments and verified emails Risk: read
Input Output

getCount

agents.getCount Count agents, optionally by status, confirmation and light agent inclusion Risk: read
Input Output

Contacts

get

contacts.get Get a contact, optionally with its accounts and owner Risk: read
Input Output

getByIds

contacts.getByIds Get up to 20 contacts by ID Risk: read
Input Output

list

contacts.list List contacts with view and saved filter, paging, sorting and field selection Risk: read
Input Output

listAccounts

contacts.listAccounts List the accounts of a contact Risk: read
Input Output

Departments

get

departments.get Get a department by ID Risk: read
Input Output

getCount

departments.getCount Count departments, optionally only enabled or disabled ones Risk: read
Input Output
departments.getLogo Download the logo of a department as base64 Risk: read
Input Output

list

departments.list List departments Risk: read
Input
Output

listTeams

departments.listTeams List the teams in a department Risk: read
Input Output

departments.uploadLogo Replace the logo of a department with a jpg, png or gif of up to 2MB Risk: write
Input Output

Organizations

list

organizations.list List the organizations the user belongs to Risk: read
Input: empty object Output

Roles

list

roles.list List roles Risk: read
Input Output

listByIds

roles.listByIds Get up to 50 roles by ID Risk: read
Input Output

Tasks

updateMany

tasks.updateMany Set one field on up to 50 tasks Risk: write
Input Output

Tickets

get

tickets.get Get a ticket by ID Risk: read
Input Output

getLatestThread

tickets.getLatestThread Get the most recent thread of a ticket, or null if it has none Risk: read
Input Output

getResolution

tickets.getResolution Get the resolution of a ticket, or null if it has none Risk: read
Input Output

getThread

tickets.getThread Get one thread of a ticket Risk: read
Input Output

list

tickets.list List tickets, filtered by department, view, assignee, team, channel, status or priority Risk: read
Input Output

listConversations

tickets.listConversations List the threads and comments of a ticket Risk: read
Input Output