API

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

Forms

create

forms.create Create a new form Risk: write

await corsair.tally.api.forms.create({});

Input

Name	Type	Required	Description
`workspaceId`	`string`	No	—
`templateId`	`string`	No	—
`status`	`string`	Yes	—
`blocks`	`object[]`	Yes	—
`settings`	`object`	No	—

blocks full type

{
}[]

settings full type

{
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`status`	`string`	No	—
`workspaceId`	`string`	No	—
`createdAt`	`string`	No	—
`updatedAt`	`string`	No	—
`blocks`	`object[]`	No	—
`settings`	`object`	No	—

blocks full type

{
}[]

settings full type

{
}

delete

forms.delete Delete a form [DESTRUCTIVE] Risk: destructive

await corsair.tally.api.forms.delete({});

Input

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

Output: void

get

forms.get Retrieve a form by ID Risk: read

await corsair.tally.api.forms.get({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`status`	`string`	No	—
`workspaceId`	`string`	No	—
`createdAt`	`string`	No	—
`updatedAt`	`string`	No	—
`blocks`	`object[]`	No	—
`settings`	`object`	No	—

blocks full type

{
}[]

settings full type

{
}

list

forms.list List all forms with optional pagination and workspace filter Risk: read

await corsair.tally.api.forms.list({});

Input

Name	Type	Required	Description
`page`	`number`	No	—
`limit`	`number`	No	—
`workspaceIds`	`string[]`	No	—

Output

Name	Type	Required	Description
`items`	`object[]`	Yes	—
`page`	`number`	No	—
`limit`	`number`	No	—
`total`	`number`	No	—
`hasMore`	`boolean`	No	—

items full type

{
  id: string,
  name?: string,
  status?: string,
  workspaceId?: string | null,
  createdAt?: string,
  updatedAt?: string,
  blocks?: {
  }[],
  settings?: {
  }
}[]

update

forms.update Update an existing form Risk: write

await corsair.tally.api.forms.update({});

Input

Name	Type	Required	Description
`formId`	`string`	Yes	—
`name`	`string`	No	—
`status`	`string`	No	—
`blocks`	`object[]`	No	—
`settings`	`object`	No	—

blocks full type

{
}[]

settings full type

{
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`status`	`string`	No	—
`workspaceId`	`string`	No	—
`createdAt`	`string`	No	—
`updatedAt`	`string`	No	—
`blocks`	`object[]`	No	—
`settings`	`object`	No	—

blocks full type

{
}[]

settings full type

{
}

Organizations

cancelInvite

organizations.cancelInvite Cancel a pending organization invite [DESTRUCTIVE] Risk: destructive

await corsair.tally.api.organizations.cancelInvite({});

Input

Name	Type	Required	Description
`organizationId`	`string`	Yes	—
`inviteId`	`string`	Yes	—

Output: void

createInvite

organizations.createInvite Invite users to an organization Risk: write

await corsair.tally.api.organizations.createInvite({});

Input

Name	Type	Required	Description
`organizationId`	`string`	Yes	—
`workspaceIds`	`string[]`	Yes	—
`emails`	`string`	Yes	—

Output: void

listInvites

organizations.listInvites List pending invites for an organization Risk: read

await corsair.tally.api.organizations.listInvites({});

Input

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

Output: object[]

Output full type

{
  id: string,
  organizationId?: string,
  email?: string,
  createdAt?: string,
  updatedAt?: string
}[]

listUsers

organizations.listUsers List all users in an organization Risk: read

await corsair.tally.api.organizations.listUsers({});

Input

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

Output: object[]

Output full type

{
  id: string,
  email?: string,
  name?: string | null,
  subscriptionPlan?: string | null
}[]

removeUser

organizations.removeUser Remove a user from an organization [DESTRUCTIVE] Risk: destructive

await corsair.tally.api.organizations.removeUser({});

Input

Name	Type	Required	Description
`organizationId`	`string`	Yes	—
`userId`	`string`	Yes	—

Output: void

Questions

list

questions.list List all questions for a form Risk: read

await corsair.tally.api.questions.list({});

Input

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

Output

Name	Type	Required	Description
`questions`	`object[]`	Yes	—
`hasResponses`	`boolean`	No	—

questions full type

{
  id: string,
  type?: string,
  title?: string | null,
  isTitleModifiedByUser?: boolean,
  formId?: string,
  isDeleted?: boolean,
  numberOfResponses?: number,
  createdAt?: string,
  updatedAt?: string,
  fields?: {
  }[]
}[]

Submissions

delete

submissions.delete Delete a form submission [DESTRUCTIVE] Risk: destructive

await corsair.tally.api.submissions.delete({});

Input

Name	Type	Required	Description
`formId`	`string`	Yes	—
`submissionId`	`string`	Yes	—

Output: void

get

submissions.get Retrieve a specific form submission Risk: read

await corsair.tally.api.submissions.get({});

Input

Name	Type	Required	Description
`formId`	`string`	Yes	—
`submissionId`	`string`	Yes	—

Output

Name	Type	Required	Description
`questions`	`object[]`	No	—
`submission`	`object`	Yes	—

questions full type

{
  id: string,
  type?: string,
  title?: string | null,
  isTitleModifiedByUser?: boolean,
  formId?: string,
  isDeleted?: boolean,
  numberOfResponses?: number,
  createdAt?: string,
  updatedAt?: string,
  fields?: {
  }[]
}[]

submission full type

{
  id: string,
  respondentId?: string | null,
  formId?: string,
  createdAt?: string,
  isCompleted?: boolean,
  responses?: {
    id: string,
    formId?: string,
    questionId?: string,
    respondentId?: string,
    submissionId?: string | null,
    sessionUuid?: string,
    answer?: any,
    formattedAnswer?: string,
    createdAt?: string,
    updatedAt?: string
  }[]
}

list

submissions.list List form submissions with optional filters Risk: read

await corsair.tally.api.submissions.list({});

Input

Name	Type	Required	Description
`formId`	`string`	Yes	—
`page`	`number`	No	—
`limit`	`number`	No	—
`filter`	`all \| completed \| partial`	No	—
`startDate`	`string`	No	—
`endDate`	`string`	No	—
`afterId`	`string`	No	—

Output

Name	Type	Required	Description
`page`	`number`	No	—
`limit`	`number`	No	—
`hasMore`	`boolean`	No	—
`totalNumberOfSubmissionsPerFilter`	`object`	No	—
`questions`	`object[]`	No	—
`submissions`	`object[]`	Yes	—

totalNumberOfSubmissionsPerFilter full type

{
}

questions full type

{
  id: string,
  type?: string,
  title?: string | null,
  isTitleModifiedByUser?: boolean,
  formId?: string,
  isDeleted?: boolean,
  numberOfResponses?: number,
  createdAt?: string,
  updatedAt?: string,
  fields?: {
  }[]
}[]

submissions full type

{
  id: string,
  respondentId?: string | null,
  formId?: string,
  createdAt?: string,
  isCompleted?: boolean,
  responses?: {
    id: string,
    formId?: string,
    questionId?: string,
    respondentId?: string,
    submissionId?: string | null,
    sessionUuid?: string,
    answer?: any,
    formattedAnswer?: string,
    createdAt?: string,
    updatedAt?: string
  }[]
}[]

Users

getMe

users.getMe Retrieve the current authenticated user Risk: read

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

Input: empty object Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`email`	`string`	No	—
`name`	`string`	No	—
`subscriptionPlan`	`string`	No	—

Webhook Management

create

webhookManagement.create Create a new webhook subscription Risk: write

await corsair.tally.api.webhookManagement.create({});

Input

Name	Type	Required	Description
`formId`	`string`	Yes	—
`url`	`string`	Yes	—
`eventTypes`	`string[]`	Yes	—
`signingSecret`	`string`	No	—
`httpHeaders`	`object[]`	No	—
`externalSubscriber`	`string`	No	—

httpHeaders full type

{
  name: string,
  value: string
}[]

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`url`	`string`	No	—
`eventTypes`	`string[]`	No	—
`isEnabled`	`boolean`	No	—
`signingSecret`	`string`	No	—
`createdAt`	`string`	No	—

delete

webhookManagement.delete Delete a webhook subscription [DESTRUCTIVE] Risk: destructive

await corsair.tally.api.webhookManagement.delete({});

Input

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

Output: void

list

webhookManagement.list List all webhooks Risk: read

await corsair.tally.api.webhookManagement.list({});

Input

Name	Type	Required	Description
`page`	`number`	No	—
`limit`	`number`	No	—

Output

Name	Type	Required	Description
`webhooks`	`object[]`	Yes	—
`page`	`number`	No	—
`limit`	`number`	No	—
`hasMore`	`boolean`	No	—
`totalCount`	`number`	No	—

webhooks full type

{
  id: string,
  url?: string,
  eventTypes?: string[],
  isEnabled?: boolean,
  signingSecret?: string | null,
  createdAt?: string
}[]

listEvents

webhookManagement.listEvents List delivery events for a webhook Risk: read

await corsair.tally.api.webhookManagement.listEvents({});

Input

Name	Type	Required	Description
`webhookId`	`string`	Yes	—
`page`	`number`	No	—

Output

Name	Type	Required	Description
`events`	`object[]`	Yes	—
`page`	`number`	No	—
`limit`	`number`	No	—
`hasMore`	`boolean`	No	—
`totalNumberOfEvents`	`number`	No	—

events full type

{
  id?: string,
  eventType?: string,
  deliveryStatus?: string,
  statusCode?: number | null,
  response?: string | null,
  retry?: number,
  payload?: {
  },
  createdAt?: string,
  updatedAt?: string
}[]

retryEvent

webhookManagement.retryEvent Retry a failed webhook event delivery Risk: write

await corsair.tally.api.webhookManagement.retryEvent({});

Input

Name	Type	Required	Description
`webhookId`	`string`	Yes	—
`eventId`	`string`	Yes	—

Output: void

update

webhookManagement.update Update a webhook subscription Risk: write

await corsair.tally.api.webhookManagement.update({});

Input

Name	Type	Required	Description
`webhookId`	`string`	Yes	—
`formId`	`string`	Yes	—
`url`	`string`	Yes	—
`eventTypes`	`string[]`	Yes	—
`isEnabled`	`boolean`	Yes	—
`signingSecret`	`string`	No	—
`httpHeaders`	`object[]`	No	—

httpHeaders full type

{
  name: string,
  value: string
}[]

Output: void

Workspaces

create

workspaces.create Create a new workspace (Pro subscription required) Risk: write

await corsair.tally.api.workspaces.create({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`createdAt`	`string`	No	—
`updatedAt`	`string`	No	—
`members`	`any[]`	No	—
`invites`	`any[]`	No	—

delete

workspaces.delete Delete a workspace [DESTRUCTIVE] Risk: destructive

await corsair.tally.api.workspaces.delete({});

Input

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

Output: void

get

workspaces.get Retrieve a workspace by ID Risk: read

await corsair.tally.api.workspaces.get({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`createdAt`	`string`	No	—
`updatedAt`	`string`	No	—
`members`	`any[]`	No	—
`invites`	`any[]`	No	—

list

workspaces.list List all workspaces Risk: read

await corsair.tally.api.workspaces.list({});

Input

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

Output

Name	Type	Required	Description
`items`	`object[]`	Yes	—
`page`	`number`	No	—
`limit`	`number`	No	—
`total`	`number`	No	—
`hasMore`	`boolean`	No	—

items full type

{
  id: string,
  name?: string,
  createdAt?: string,
  updatedAt?: string,
  members?: any[],
  invites?: any[]
}[]

update

workspaces.update Update a workspace name Risk: write

await corsair.tally.api.workspaces.update({});

Input

Name	Type	Required	Description
`workspaceId`	`string`	Yes	—
`name`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`createdAt`	`string`	No	—
`updatedAt`	`string`	No	—
`members`	`any[]`	No	—
`invites`	`any[]`	No	—

Overview

Plugins

Forms

create

delete

get

list

update

Organizations

cancelInvite

createInvite

listInvites

listUsers

removeUser

Questions

list

Submissions

delete

get

list

Users

getMe

Webhook Management

create

delete

list

listEvents

retryEvent

update

Workspaces

create

delete

get

list

update

Overview

Plugins

Documentation Index

​Forms

​create

​delete

​get

​list

​update

​Organizations

​cancelInvite

​createInvite

​listInvites

​listUsers

​removeUser

​Questions

​list

​Submissions

​delete

​get

​list

​Users

​getMe

​Webhook Management

​create

​delete

​list

​listEvents

​retryEvent

​update

​Workspaces

​create

​delete

​get

​list

​update

Forms

create

delete

get

list

update

Organizations

cancelInvite

createInvite

listInvites

listUsers

removeUser

Questions

list

Submissions

delete

get

list

Users

getMe

Webhook Management

create

delete

list

listEvents

retryEvent

update

Workspaces

create

delete

get

list

update