API - Corsair

Every zendesk.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

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

Comments

list

comments.list List comments for a specific ticket Risk: read

await corsair.zendesk.api.comments.list({
  ticket_id: 12345
});

Input

Name	Type	Required	Description
`ticket_id`	`number`	Yes	—
`page`	`number`	No	—
`per_page`	`number`	No	—

Output

Name	Type	Required	Description
`comments`	`object[]`	Yes	—
`next_page`	`string`	No	—
`previous_page`	`string`	No	—
`count`	`number`	No	—

comments full type

{
  id: number,
  type?: string | null,
  body?: string | null,
  html_body?: string | null,
  plain_body?: string | null,
  public?: boolean | null,
  author_id?: number | null,
  attachments?: any[] | null,
  created_at?: string | null
}[]

Tickets

create

tickets.create Create a new ticket Risk: write

await corsair.zendesk.api.tickets.create({});

Input

Name	Type	Required	Description
`subject`	`string`	No	—
`description`	`string`	No	—
`comment`	`object`	No	—
`status`	`string`	No	—
`priority`	`string`	No	—
`requester_id`	`number`	No	—
`assignee_id`	`number`	No	—
`group_id`	`number`	No	—
`organization_id`	`number`	No	—
`tags`	`string[]`	No	—

comment full type

{
  body: string,
  public?: boolean,
  author_id?: number
}

Output

Name	Type	Required	Description
`ticket`	`object`	Yes	—

ticket full type

{
  id: number,
  url?: string | null,
  external_id?: string | null,
  created_at?: string | null,
  updated_at?: string | null,
  type?: string | null,
  subject?: string | null,
  raw_subject?: string | null,
  description?: string | null,
  priority?: string | null,
  status?: string | null,
  recipient?: string | null,
  requester_id?: number | null,
  submitter_id?: number | null,
  assignee_id?: number | null,
  organization_id?: number | null,
  group_id?: number | null,
  collaborator_ids?: number[] | null,
  follower_ids?: number[] | null,
  email_cc_ids?: number[] | null,
  forum_topic_id?: number | null,
  problem_id?: number | null,
  has_incidents?: boolean | null,
  is_public?: boolean | null,
  due_at?: string | null,
  tags?: string[] | null
}

delete

tickets.delete Delete a ticket by its ID Risk: destructive

await corsair.zendesk.api.tickets.delete({
  id: 12345
});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—

Output

Name	Type	Required	Description
`id`	`number`	No	—

get

tickets.get Retrieve a ticket by its ID Risk: read

await corsair.zendesk.api.tickets.get({
  id: 12345
});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—

Output

Name	Type	Required	Description
`ticket`	`object`	Yes	—

ticket full type

{
  id: number,
  url?: string | null,
  external_id?: string | null,
  created_at?: string | null,
  updated_at?: string | null,
  type?: string | null,
  subject?: string | null,
  raw_subject?: string | null,
  description?: string | null,
  priority?: string | null,
  status?: string | null,
  recipient?: string | null,
  requester_id?: number | null,
  submitter_id?: number | null,
  assignee_id?: number | null,
  organization_id?: number | null,
  group_id?: number | null,
  collaborator_ids?: number[] | null,
  follower_ids?: number[] | null,
  email_cc_ids?: number[] | null,
  forum_topic_id?: number | null,
  problem_id?: number | null,
  has_incidents?: boolean | null,
  is_public?: boolean | null,
  due_at?: string | null,
  tags?: string[] | null
}

list

tickets.list List tickets with pagination Risk: read

await corsair.zendesk.api.tickets.list({});

Input

Name	Type	Required	Description
`page`	`number`	No	—
`per_page`	`number`	No	—
`sort_by`	`string`	No	—
`sort_order`	`string`	No	—

Output

Name	Type	Required	Description
`tickets`	`object[]`	Yes	—
`next_page`	`string`	No	—
`previous_page`	`string`	No	—
`count`	`number`	No	—

tickets full type

{
  id: number,
  url?: string | null,
  external_id?: string | null,
  created_at?: string | null,
  updated_at?: string | null,
  type?: string | null,
  subject?: string | null,
  raw_subject?: string | null,
  description?: string | null,
  priority?: string | null,
  status?: string | null,
  recipient?: string | null,
  requester_id?: number | null,
  submitter_id?: number | null,
  assignee_id?: number | null,
  organization_id?: number | null,
  group_id?: number | null,
  collaborator_ids?: number[] | null,
  follower_ids?: number[] | null,
  email_cc_ids?: number[] | null,
  forum_topic_id?: number | null,
  problem_id?: number | null,
  has_incidents?: boolean | null,
  is_public?: boolean | null,
  due_at?: string | null,
  tags?: string[] | null
}[]

update

tickets.update Update an existing ticket Risk: write

await corsair.zendesk.api.tickets.update({
  id: 12345,
  subject: "Updated ticket subject"
});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`subject`	`string`	No	—
`status`	`string`	No	—
`priority`	`string`	No	—
`requester_id`	`number`	No	—
`assignee_id`	`number`	No	—
`comment`	`object`	No	—
`tags`	`string[]`	No	—

comment full type

{
  body: string,
  public?: boolean,
  author_id?: number
}

Output

Name	Type	Required	Description
`ticket`	`object`	Yes	—

ticket full type

{
  id: number,
  url?: string | null,
  external_id?: string | null,
  created_at?: string | null,
  updated_at?: string | null,
  type?: string | null,
  subject?: string | null,
  raw_subject?: string | null,
  description?: string | null,
  priority?: string | null,
  status?: string | null,
  recipient?: string | null,
  requester_id?: number | null,
  submitter_id?: number | null,
  assignee_id?: number | null,
  organization_id?: number | null,
  group_id?: number | null,
  collaborator_ids?: number[] | null,
  follower_ids?: number[] | null,
  email_cc_ids?: number[] | null,
  forum_topic_id?: number | null,
  problem_id?: number | null,
  has_incidents?: boolean | null,
  is_public?: boolean | null,
  due_at?: string | null,
  tags?: string[] | null
}

Users

create

users.create Create a new user Risk: write

await corsair.zendesk.api.users.create({
  name: "Jane Doe",
  email: "jane.doe@example.com"
});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`email`	`string`	Yes	—
`role`	`string`	No	—
`external_id`	`string`	No	—
`active`	`boolean`	No	—

Output

Name	Type	Required	Description
`user`	`object`	Yes	—

user full type

{
  id: number,
  url?: string | null,
  name: string,
  email?: string | null,
  created_at?: string | null,
  updated_at?: string | null,
  time_zone?: string | null,
  iana_time_zone?: string | null,
  phone?: string | null,
  shared_phone?: boolean | null,
  locale_id?: number | null,
  locale?: string | null,
  organization_id?: number | null,
  role?: string | null,
  verified?: boolean | null,
  external_id?: string | null,
  tags?: string[] | null,
  active?: boolean | null
}

delete

users.delete Delete a user by their ID Risk: destructive

await corsair.zendesk.api.users.delete({
  id: 12345
});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—

Output

Name	Type	Required	Description
`id`	`number`	No	—

get

users.get Retrieve a user by their ID Risk: read

await corsair.zendesk.api.users.get({
  id: 12345
});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—

Output

Name	Type	Required	Description
`user`	`object`	Yes	—

user full type

{
  id: number,
  url?: string | null,
  name: string,
  email?: string | null,
  created_at?: string | null,
  updated_at?: string | null,
  time_zone?: string | null,
  iana_time_zone?: string | null,
  phone?: string | null,
  shared_phone?: boolean | null,
  locale_id?: number | null,
  locale?: string | null,
  organization_id?: number | null,
  role?: string | null,
  verified?: boolean | null,
  external_id?: string | null,
  tags?: string[] | null,
  active?: boolean | null
}

list

users.list List users with pagination Risk: read

await corsair.zendesk.api.users.list({});

Input

Name	Type	Required	Description
`page`	`number`	No	—
`per_page`	`number`	No	—
`role`	`string`	No	—

Output

Name	Type	Required	Description
`users`	`object[]`	Yes	—
`next_page`	`string`	No	—
`previous_page`	`string`	No	—
`count`	`number`	No	—

users full type

{
  id: number,
  url?: string | null,
  name: string,
  email?: string | null,
  created_at?: string | null,
  updated_at?: string | null,
  time_zone?: string | null,
  iana_time_zone?: string | null,
  phone?: string | null,
  shared_phone?: boolean | null,
  locale_id?: number | null,
  locale?: string | null,
  organization_id?: number | null,
  role?: string | null,
  verified?: boolean | null,
  external_id?: string | null,
  tags?: string[] | null,
  active?: boolean | null
}[]

update

users.update Update an existing user Risk: write

await corsair.zendesk.api.users.update({
  id: 12345,
  name: "Jane Smith"
});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`name`	`string`	No	—
`email`	`string`	No	—
`role`	`string`	No	—
`external_id`	`string`	No	—
`active`	`boolean`	No	—

Output

Name	Type	Required	Description
`user`	`object`	Yes	—

user full type

{
  id: number,
  url?: string | null,
  name: string,
  email?: string | null,
  created_at?: string | null,
  updated_at?: string | null,
  time_zone?: string | null,
  iana_time_zone?: string | null,
  phone?: string | null,
  shared_phone?: boolean | null,
  locale_id?: number | null,
  locale?: string | null,
  organization_id?: number | null,
  role?: string | null,
  verified?: boolean | null,
  external_id?: string | null,
  tags?: string[] | null,
  active?: boolean | null
}

Documentation Index

​Comments

​list

​Tickets

​create

​delete

​get

​list

​update

​Users

​create

​delete

​get

​list

​update

Comments

list

Tickets

create

delete

get

list

update

Users

create

delete

get

list

update