API - Corsair

Every close.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.

Activities

createNote

activities.createNote Create a note activity Risk: write

await corsair.close.api.activities.createNote({ lead_id: 'lead_123', note: 'Example note' });

Input

Name	Type	Required	Description
`lead_id`	`string`	Yes	—
`note`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`lead_id`	`string`	No	—
`note`	`string`	No	—
`user_id`	`string`	No	—
`organization_id`	`string`	No	—
`date_created`	`string`	No	—
`date_updated`	`string`	No	—

listCalls

activities.listCalls List call activities Risk: read

await corsair.close.api.activities.listCalls({});

Input

Name	Type	Required	Description
`lead_id`	`string`	No	—
`_limit`	`number`	No	—
`_skip`	`number`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`has_more`	`boolean`	No	—

data full type

{
  id: string,
  lead_id?: string,
  phone?: string,
  direction?: string,
  duration?: number,
  status?: string,
  user_id?: string | null,
  organization_id?: string,
  date_created?: string
}[]

createCall

activities.createCall Create a call activity Risk: write

await corsair.close.api.activities.createCall({ lead_id: 'lead_123', direction: 'outbound' });

Input

Name	Type	Required	Description
`lead_id`	`string`	Yes	—
`direction`	`'inbound' \| 'outbound'`	No	—
`contact_id`	`string`	No	—
`phone`	`string`	No	—
`duration`	`number`	No	—
`note`	`string`	No	—
`recording_url`	`string`	No	—
`user_id`	`string`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`lead_id`	`string`	No	—
`phone`	`string`	No	—
`direction`	`string`	No	—
`duration`	`number`	No	—
`status`	`string`	No	—
`user_id`	`string \| null`	No	—
`organization_id`	`string`	No	—
`date_created`	`string`	No	—

deleteCall

activities.deleteCall Delete a call activity Risk: destructive

await corsair.close.api.activities.deleteCall({ id: 'call_123' });

Input

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

Output

Name	Type	Required	Description
`success`	`boolean`	Yes	—
`id`	`string`	Yes	—

createSms

activities.createSms Create an SMS activity Risk: write

await corsair.close.api.activities.createSms({ lead_id: 'lead_123', local_phone: '+15551234567', text: 'Hello' });

Input

Name	Type	Required	Description
`lead_id`	`string`	Yes	—
`local_phone`	`string`	Yes	—
`text`	`string`	No	—
`direction`	`'inbound' \| 'outbound'`	No	—
`status`	`'inbox' \| 'draft' \| 'scheduled' \| 'outbox' \| 'sent' \| 'error'`	No	—
`contact_id`	`string`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`lead_id`	`string`	No	—
`local_phone`	`string`	No	—
`remote_phone`	`string`	No	—
`text`	`string`	No	—
`direction`	`string`	No	—
`status`	`string`	No	—
`user_id`	`string \| null`	No	—
`organization_id`	`string`	No	—
`date_created`	`string`	No	—

listEmails

activities.listEmails List email activities Risk: read

await corsair.close.api.activities.listEmails({});

Input

Name	Type	Required	Description
`lead_id`	`string`	No	—
`_limit`	`number`	No	—
`_skip`	`number`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`has_more`	`boolean`	No	—

data full type

{
  id: string,
  lead_id?: string,
  subject?: string,
  body_text?: string,
  sender?: string,
  direction?: string,
  user_id?: string | null,
  organization_id?: string,
  date_created?: string
}[]

listNotes

activities.listNotes List note activities Risk: read

await corsair.close.api.activities.listNotes({});

Input

Name	Type	Required	Description
`lead_id`	`string`	No	—
`_limit`	`number`	No	—
`_skip`	`number`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`has_more`	`boolean`	No	—

data full type

{
  id: string,
  lead_id?: string,
  note?: string,
  user_id?: string | null,
  organization_id?: string,
  date_created?: string,
  date_updated?: string
}[]

Contacts

create

contacts.create Create a contact Risk: write

await corsair.close.api.contacts.create({ lead_id: 'lead_123' });

Input

Name	Type	Required	Description
`lead_id`	`string`	Yes	—
`name`	`string`	No	—
`title`	`string`	No	—
`emails`	`object[]`	No	—
`phones`	`object[]`	No	—

emails full type

{
  email: string,
  type?: string
}[]

phones full type

{
  phone: string,
  type?: string
}[]

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`lead_id`	`string`	No	—
`name`	`string`	No	—
`title`	`string`	No	—
`emails`	`object[]`	No	—
`phones`	`object[]`	No	—
`organization_id`	`string`	No	—
`created_by`	`string`	No	—
`date_created`	`string`	No	—
`date_updated`	`string`	No	—

emails full type

{
  email: string,
  type?: string
}[]

phones full type

{
  phone: string,
  type?: string
}[]

delete

contacts.delete Delete a contact Risk: destructive

await corsair.close.api.contacts.delete({ id: 'cont_123' });

Input

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

Output

Name	Type	Required	Description
`success`	`boolean`	Yes	—
`id`	`string`	Yes	—

get

contacts.get Retrieve a contact by ID Risk: read

await corsair.close.api.contacts.get({ id: 'cont_123' });

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`lead_id`	`string`	No	—
`name`	`string`	No	—
`title`	`string`	No	—
`emails`	`object[]`	No	—
`phones`	`object[]`	No	—
`organization_id`	`string`	No	—
`created_by`	`string`	No	—
`date_created`	`string`	No	—
`date_updated`	`string`	No	—

emails full type

{
  email: string,
  type?: string
}[]

phones full type

{
  phone: string,
  type?: string
}[]

list

contacts.list List contacts Risk: read

await corsair.close.api.contacts.list({});

Input

Name	Type	Required	Description
`lead_id`	`string`	No	—
`_limit`	`number`	No	—
`_skip`	`number`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`has_more`	`boolean`	No	—

data full type

{
  id: string,
  lead_id?: string,
  name?: string,
  title?: string | null,
  emails?: {
    email: string,
    type?: string
  }[],
  phones?: {
    phone: string,
    type?: string
  }[],
  organization_id?: string,
  created_by?: string | null,
  date_created?: string,
  date_updated?: string
}[]

update

contacts.update Update a contact Risk: write

await corsair.close.api.contacts.update({ id: 'cont_123' });

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`title`	`string`	No	—
`emails`	`object[]`	No	—
`phones`	`object[]`	No	—

emails full type

{
  email: string,
  type?: string
}[]

phones full type

{
  phone: string,
  type?: string
}[]

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`lead_id`	`string`	No	—
`name`	`string`	No	—
`title`	`string`	No	—
`emails`	`object[]`	No	—
`phones`	`object[]`	No	—
`organization_id`	`string`	No	—
`created_by`	`string`	No	—
`date_created`	`string`	No	—
`date_updated`	`string`	No	—

emails full type

{
  email: string,
  type?: string
}[]

phones full type

{
  phone: string,
  type?: string
}[]

Custom Fields

listContact

customFields.listContact List contact custom fields Risk: read

await corsair.close.api.customFields.listContact({});

Input: empty object Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—

data full type

{
  id: string,
  name?: string,
  type?: string,
  choices?: string[],
  organization_id?: string
}[]

listLead

customFields.listLead List lead custom fields Risk: read

await corsair.close.api.customFields.listLead({});

Input: empty object Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—

data full type

{
  id: string,
  name?: string,
  type?: string,
  choices?: string[],
  organization_id?: string
}[]

Leads

create

leads.create Create a new lead Risk: write

await corsair.close.api.leads.create({});

Input

Name	Type	Required	Description
`name`	`string`	No	—
`status_id`	`string`	No	—
`description`	`string`	No	—
`url`	`string`	No	—
`custom`	`object`	No	—
`contacts`	`object[]`	No	—

custom full type

Record<string, unknown>

contacts full type

Record<string, unknown>[]

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`status_id`	`string`	No	—
`status_label`	`string`	No	—
`description`	`string`	No	—
`url`	`string`	No	—
`organization_id`	`string`	No	—
`contacts`	`object[]`	No	—
`custom`	`object`	No	—
`created_by`	`string`	No	—
`updated_by`	`string`	No	—
`date_created`	`string`	No	—
`date_updated`	`string`	No	—

contacts full type

Record<string, unknown>[]

custom full type

Record<string, unknown>

delete

leads.delete Delete a lead by ID Risk: destructive

await corsair.close.api.leads.delete({ id: 'lead_123' });

Input

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

Output

Name	Type	Required	Description
`success`	`boolean`	Yes	—
`id`	`string`	Yes	—

get

leads.get Retrieve a lead by ID Risk: read

await corsair.close.api.leads.get({ id: 'lead_123' });

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`status_id`	`string`	No	—
`status_label`	`string`	No	—
`description`	`string`	No	—
`url`	`string`	No	—
`organization_id`	`string`	No	—
`contacts`	`object[]`	No	—
`custom`	`object`	No	—
`created_by`	`string`	No	—
`updated_by`	`string`	No	—
`date_created`	`string`	No	—
`date_updated`	`string`	No	—

contacts full type

Record<string, unknown>[]

custom full type

Record<string, unknown>

list

leads.list List leads with optional filters Risk: read

await corsair.close.api.leads.list({});

Input

Name	Type	Required	Description
`_limit`	`number`	No	—
`_skip`	`number`	No	—
`query`	`string`	No	—
`status_id`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`has_more`	`boolean`	No	—
`total_results`	`number`	No	—

data full type

{
  id: string,
  name?: string,
  status_id?: string | null,
  status_label?: string | null,
  description?: string | null,
  url?: string | null,
  organization_id?: string,
  contacts?: Record<string, unknown>[],
  custom?: Record<string, unknown>,
  created_by?: string | null,
  updated_by?: string | null,
  date_created?: string,
  date_updated?: string
}[]

update

leads.update Update an existing lead Risk: write

await corsair.close.api.leads.update({ id: 'lead_123' });

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`status_id`	`string`	No	—
`description`	`string`	No	—
`url`	`string`	No	—
`custom`	`object`	No	—

custom full type

Record<string, unknown>

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`status_id`	`string`	No	—
`status_label`	`string`	No	—
`description`	`string`	No	—
`url`	`string`	No	—
`organization_id`	`string`	No	—
`contacts`	`object[]`	No	—
`custom`	`object`	No	—
`created_by`	`string`	No	—
`updated_by`	`string`	No	—
`date_created`	`string`	No	—
`date_updated`	`string`	No	—

contacts full type

Record<string, unknown>[]

custom full type

Record<string, unknown>

Opportunities

create

opportunities.create Create an opportunity Risk: write

await corsair.close.api.opportunities.create({ lead_id: 'lead_123', status_id: 'status_123' });

Input

Name	Type	Required	Description
`lead_id`	`string`	Yes	—
`status_id`	`string`	Yes	—
`value`	`number`	No	—
`value_period`	`string`	No	—
`confidence`	`number`	No	—
`user_id`	`string`	No	—
`note`	`string`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`lead_id`	`string`	No	—
`lead_name`	`string`	No	—
`status_id`	`string`	No	—
`status_label`	`string`	No	—
`status_type`	`string`	No	—
`value`	`number`	No	—
`value_period`	`string`	No	—
`confidence`	`number`	No	—
`user_id`	`string`	No	—
`organization_id`	`string`	No	—
`date_won`	`string`	No	—
`date_lost`	`string`	No	—
`date_created`	`string`	No	—
`date_updated`	`string`	No	—

delete

opportunities.delete Delete an opportunity Risk: destructive

await corsair.close.api.opportunities.delete({ id: 'opp_123' });

Input

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

Output

Name	Type	Required	Description
`success`	`boolean`	Yes	—
`id`	`string`	Yes	—

get

opportunities.get Retrieve an opportunity by ID Risk: read

await corsair.close.api.opportunities.get({ id: 'opp_123' });

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`lead_id`	`string`	No	—
`lead_name`	`string`	No	—
`status_id`	`string`	No	—
`status_label`	`string`	No	—
`status_type`	`string`	No	—
`value`	`number`	No	—
`value_period`	`string`	No	—
`confidence`	`number`	No	—
`user_id`	`string`	No	—
`organization_id`	`string`	No	—
`date_won`	`string`	No	—
`date_lost`	`string`	No	—
`date_created`	`string`	No	—
`date_updated`	`string`	No	—

list

opportunities.list List opportunities Risk: read

await corsair.close.api.opportunities.list({});

Input

Name	Type	Required	Description
`lead_id`	`string`	No	—
`status_id`	`string`	No	—
`user_id`	`string`	No	—
`_limit`	`number`	No	—
`_skip`	`number`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`has_more`	`boolean`	No	—

data full type

{
  id: string,
  lead_id?: string,
  lead_name?: string,
  status_id?: string,
  status_label?: string,
  status_type?: string,
  value?: number,
  value_period?: string,
  confidence?: number,
  user_id?: string | null,
  organization_id?: string,
  date_won?: string | null,
  date_lost?: string | null,
  date_created?: string,
  date_updated?: string
}[]

update

opportunities.update Update an opportunity Risk: write

await corsair.close.api.opportunities.update({ id: 'opp_123' });

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`status_id`	`string`	No	—
`value`	`number`	No	—
`value_period`	`string`	No	—
`confidence`	`number`	No	—
`user_id`	`string`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`lead_id`	`string`	No	—
`lead_name`	`string`	No	—
`status_id`	`string`	No	—
`status_label`	`string`	No	—
`status_type`	`string`	No	—
`value`	`number`	No	—
`value_period`	`string`	No	—
`confidence`	`number`	No	—
`user_id`	`string`	No	—
`organization_id`	`string`	No	—
`date_won`	`string`	No	—
`date_lost`	`string`	No	—
`date_created`	`string`	No	—
`date_updated`	`string`	No	—

Tasks

create

tasks.create Create a task Risk: write

await corsair.close.api.tasks.create({ lead_id: 'lead_123', text: 'example' });

Input

Name	Type	Required	Description
`lead_id`	`string`	Yes	—
`text`	`string`	Yes	—
`due_date`	`string`	No	—
`assigned_to`	`string`	No	—
`type`	`string`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`lead_id`	`string`	No	—
`text`	`string`	No	—
`due_date`	`string`	No	—
`is_complete`	`boolean`	No	—
`assigned_to`	`string`	No	—
`type`	`string`	No	—
`organization_id`	`string`	No	—
`created_by`	`string`	No	—
`date_created`	`string`	No	—
`date_updated`	`string`	No	—

delete

tasks.delete Delete a task Risk: destructive

await corsair.close.api.tasks.delete({ id: 'task_123' });

Input

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

Output

Name	Type	Required	Description
`success`	`boolean`	Yes	—
`id`	`string`	Yes	—

get

tasks.get Retrieve a task by ID Risk: read

await corsair.close.api.tasks.get({ id: 'task_123' });

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`lead_id`	`string`	No	—
`text`	`string`	No	—
`due_date`	`string`	No	—
`is_complete`	`boolean`	No	—
`assigned_to`	`string`	No	—
`type`	`string`	No	—
`organization_id`	`string`	No	—
`created_by`	`string`	No	—
`date_created`	`string`	No	—
`date_updated`	`string`	No	—

list

tasks.list List tasks Risk: read

await corsair.close.api.tasks.list({});

Input

Name	Type	Required	Description
`lead_id`	`string`	No	—
`is_complete`	`boolean`	No	—
`assigned_to`	`string`	No	—
`_limit`	`number`	No	—
`_skip`	`number`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`has_more`	`boolean`	No	—

data full type

{
  id: string,
  lead_id?: string,
  text?: string,
  due_date?: string | null,
  is_complete?: boolean,
  assigned_to?: string | null,
  type?: string,
  organization_id?: string,
  created_by?: string | null,
  date_created?: string,
  date_updated?: string
}[]

update

tasks.update Update a task Risk: write

await corsair.close.api.tasks.update({ id: 'task_123' });

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`text`	`string`	No	—
`due_date`	`string`	No	—
`is_complete`	`boolean`	No	—
`assigned_to`	`string`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`lead_id`	`string`	No	—
`text`	`string`	No	—
`due_date`	`string`	No	—
`is_complete`	`boolean`	No	—
`assigned_to`	`string`	No	—
`type`	`string`	No	—
`organization_id`	`string`	No	—
`created_by`	`string`	No	—
`date_created`	`string`	No	—
`date_updated`	`string`	No	—

Users

getMe

users.getMe Get current authenticated user info Risk: read

await corsair.close.api.users.getMe({});

Input: empty object Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`first_name`	`string`	No	—
`last_name`	`string`	No	—
`email`	`string`	No	—
`image`	`string`	No	—
`organization_id`	`string`	No	—

list

users.list List users in the organization Risk: read

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

Input

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

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—

data full type

{
  id: string,
  first_name?: string,
  last_name?: string,
  email?: string,
  image?: string | null,
  organization_id?: string
}[]

​Activities

​createNote

​listCalls

​createCall

​deleteCall

​createSms

​listEmails

​listNotes

​Contacts

​create

​delete

​get

​list

​update

​Custom Fields

​listContact

​listLead

​Leads

​create

​delete

​get

​list

​update

​Opportunities

​create

​delete

​get

​list

​update

​Tasks

​create

​delete

​get

​list

​update

​Users

​getMe

​list

Activities

createNote

listCalls

createCall

deleteCall

createSms

listEmails

listNotes

Contacts

create

delete

get

list

update

Custom Fields

listContact

listLead

Leads

create

delete

get

list

update

Opportunities

create

delete

get

list

update

Tasks

create

delete

get

list

update

Users

getMe

list