> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# GoDial API reference

> API reference for the GoDial plugin in Corsair: every `godial.api.*` operation with its input and output types, taken from the plugin's Zod schemas.

> [!NOTE]
>
> **New to Corsair?** See [API access](https://docs.corsair.dev/concepts/api.md), [authentication](https://docs.corsair.dev/concepts/auth.md), and [error handling](https://docs.corsair.dev/concepts/error-handling).

## Contacts

### add

`contacts.add`

Add a contact (lead) to a GoDial list; assignmentMode or accountsId assigns it to an agent for calling

**Risk:** `write`

```ts theme={null}
await corsair.godial.api.contacts.add({ listId: 'list-123', name: 'Ada Lovelace', phone: '+15555550123' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `name` | `string` | No | — |
| `email` | `string` | No | — |
| `phone` | `string` | Yes | — |
| `secondPhone` | `string` | No | — |
| `companyName` | `string` | No | — |
| `note` | `string` | No | — |
| `remarks` | `string` | No | — |
| `extra` | `string` | No | — |
| `assignmentMode` | `default \| roundrobin` | No | — |
| `customFields` | `object[]` | No | — |
| `listId` | `string` | Yes | — |
| `accountsId` | `string` | No | — |
| `source` | `string` | No | — |
| `address` | `string` | No | — |
| `source_marketing` | `object` | No | — |

phone and listId are required. With assignmentMode 'roundrobin' or an accountsId the contact is assigned to an agent and joins that agent's calling queue. The reference shows only an empty example response.

> [accordion] customFields full type
>
> ```ts theme={null}
> {
>   name: string,
>   value: string
> }[]
> ```

> [accordion] source\_marketing full type
>
> ```ts theme={null}
> {
>   source?: string,
>   medium?: string,
>   campaign?: string,
>   term?: string,
>   content?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string \| number` | Yes | — |
| `name` | `string \| null` | No | — |
| `phone` | `string \| null` | No | — |
| `secondPhone` | `string \| null` | No | — |
| `email` | `string \| null` | No | — |
| `companyName` | `string \| null` | No | — |
| `note` | `string \| null` | No | — |
| `remarks` | `string \| null` | No | — |
| `extra` | `string \| null` | No | — |
| `listId` | `string \| number \| null` | No | — |
| `companyId` | `string \| number \| null` | No | — |
| `stageId` | `string \| number \| null` | No | — |
| `source` | `string \| null` | No | — |
| `createdOn` | `string \| null` | No | — |
| `called` | `boolean \| null` | No | — |
| `dnc` | `boolean \| null` | No | — |
| `leadScore` | `number \| null` | No | — |
| `customFields` | `any` | No | — |
| `source_marketing` | `any` | No | — |

***

## Lists

### list

`lists.list`

List the authenticated GoDial account’s lists

**Risk:** `read`

```ts theme={null}
await corsair.godial.api.lists.list({});
```

**Input:** *empty object*

GoDial's reference (godial.stoplight.io) shows only an empty example response, so the result schema comes from live responses: an array of lists, each with an id. Other fields pass through as GoDial sends them, except the IndiaMart block, which keeps only `enabled` because it also carries that integration's API key. A response that isn't an array of objects with ids fails validation.

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   id: string | number,
>   name?: string | null,
>   system?: boolean | null,
>   callScript?: string | null,
>   companyId?: string | number | null,
>   teamsId?: string | number | null,
>   indiamart?: {
>     enabled?: boolean | null
>   } | null
> }[]
> ```

***


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.