API

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

Databases

create

databases.create Create a Zite database with tables and fields Risk: write

await corsair.filloutforms.api.databases.create({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`tables`	`object[]`	Yes	—

tables full type

{
  name: string,
  fields: {
    type: single_line_text | long_text | email | url | phone_number | number | currency | percent | rating | duration | single_select | multiple_select | checkbox | date | datetime | attachments | linked_record | lookup | autonumber | source,
    name: string,
    template: {
    }
  }[]
}[]

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	Yes	—
`tables`	`object[]`	Yes	—
`createdAt`	`string`	Yes	—
`updatedAt`	`string`	Yes	—
`url`	`string`	Yes	—
`workspaceId`	`string`	No	—

tables full type

{
  id: string,
  name: string,
  order: number,
  primaryFieldId: string,
  fields: {
    id: string,
    name: string,
    type: string,
    template: {
    },
    order: number
  }[],
  views: {
    id: string,
    name: string,
    type: string,
    config?: {
    }
  }[],
  url: string
}[]

delete

databases.delete Permanently delete a Zite database Risk: destructive

await corsair.filloutforms.api.databases.delete({});

Input

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

Output: empty object

get

databases.get List Zite databases for the organization Risk: read

await corsair.filloutforms.api.databases.get({});

Input: empty object Output: object[]

Output full type

{
  id: string,
  name: string,
  url?: string
}[]

getById

databases.getById Get a Zite database with tables, fields, and views Risk: read

await corsair.filloutforms.api.databases.getById({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	Yes	—
`tables`	`object[]`	Yes	—
`createdAt`	`string`	Yes	—
`updatedAt`	`string`	Yes	—
`url`	`string`	Yes	—
`workspaceId`	`string`	No	—

tables full type

{
  id: string,
  name: string,
  order: number,
  primaryFieldId: string,
  fields: {
    id: string,
    name: string,
    type: string,
    template: {
    },
    order: number
  }[],
  views: {
    id: string,
    name: string,
    type: string,
    config?: {
    }
  }[],
  url: string
}[]

Fields

create

fields.create Add a field to a Zite table Risk: write

await corsair.filloutforms.api.fields.create({});

Input

Name	Type	Required	Description
`databaseId`	`string`	Yes	—
`tableId`	`string`	Yes	—
`name`	`string`	Yes	—
`type`	`single_line_text \| long_text \| email \| url \| phone_number \| number \| currency \| percent \| rating \| duration \| single_select \| multiple_select \| checkbox \| date \| datetime \| attachments \| linked_record \| lookup \| autonumber \| source`	Yes	—
`template`	`object`	No	—

template full type

{
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	Yes	—
`type`	`string`	Yes	—
`template`	`object`	Yes	—
`order`	`number`	Yes	—

template full type

{
}

delete

fields.delete Permanently delete a Zite field Risk: destructive

await corsair.filloutforms.api.fields.delete({});

Input

Name	Type	Required	Description
`databaseId`	`string`	Yes	—
`tableId`	`string`	Yes	—
`fieldId`	`string`	Yes	—

Output: empty object

update

fields.update Update a Zite field name or template Risk: write

await corsair.filloutforms.api.fields.update({});

Input

Name	Type	Required	Description
`databaseId`	`string`	Yes	—
`tableId`	`string`	Yes	—
`fieldId`	`string`	Yes	—
`name`	`string`	No	—
`template`	`object`	No	—

template full type

{
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	Yes	—
`type`	`string`	Yes	—
`template`	`object`	Yes	—
`order`	`number`	Yes	—

template full type

{
}

Forms

getFormMetadata

forms.getFormMetadata Get form metadata including questions and configuration Risk: read

await corsair.filloutforms.api.forms.getFormMetadata({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	Yes	—
`questions`	`object[]`	Yes	—
`calculations`	`object[]`	No	—
`urlParameters`	`object[]`	No	—
`scheduling`	`object[]`	No	—
`payments`	`object[]`	No	—
`quiz`	`object`	No	—

questions full type

{
  id: string,
  name: string,
  type: string
}[]

calculations full type

{
}[]

urlParameters full type

{
}[]

scheduling full type

{
}[]

payments full type

{
}[]

quiz full type

{
}

getForms

forms.getForms List all Fillout forms Risk: read

await corsair.filloutforms.api.forms.getForms({});

Input: empty object Output: object[]

Output full type

{
  formId: string,
  name: string
}[]

Oauth

authorize

oauth.authorize Generate the Fillout OAuth authorization URL Risk: read

await corsair.filloutforms.api.oauth.authorize({});

Input

Name	Type	Required	Description
`clientId`	`string`	Yes	—
`redirectUri`	`string`	Yes	—
`state`	`string`	No	—

Output

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

Records

create

records.create Create a Zite record Risk: write

await corsair.filloutforms.api.records.create({});

Input

Name	Type	Required	Description
`databaseId`	`string`	Yes	—
`tableId`	`string`	Yes	—
`record`	`object`	Yes	—

record full type

{
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`data`	`object`	Yes	—
`fields`	`object`	Yes	—
`createdAt`	`string`	Yes	—
`updatedAt`	`string`	Yes	—

data full type

{
}

fields full type

{
}

delete

records.delete Permanently delete a Zite record Risk: destructive

await corsair.filloutforms.api.records.delete({});

Input

Name	Type	Required	Description
`databaseId`	`string`	Yes	—
`tableId`	`string`	Yes	—
`recordId`	`string`	Yes	—

Output: empty object

getById

records.getById Get a Zite record by UUID Risk: read

await corsair.filloutforms.api.records.getById({});

Input

Name	Type	Required	Description
`databaseId`	`string`	Yes	—
`tableId`	`string`	Yes	—
`recordId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`data`	`object`	Yes	—
`fields`	`object`	Yes	—
`createdAt`	`string`	Yes	—
`updatedAt`	`string`	Yes	—

data full type

{
}

fields full type

{
}

list

records.list List Zite records with filter, sort, and pagination Risk: read

await corsair.filloutforms.api.records.list({});

Input

Name	Type	Required	Description
`databaseId`	`string`	Yes	—
`tableId`	`string`	Yes	—
`filter`	`object`	No	—
`sort`	`object[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—

filter full type

{
}

sort full type

{
}[]

Output

Name	Type	Required	Description
`records`	`object[]`	Yes	—
`total`	`number`	No	—

records full type

{
  id: string,
  data: {
  },
  fields: {
  },
  createdAt: string,
  updatedAt: string
}[]

update

records.update Update fields on a Zite record Risk: write

await corsair.filloutforms.api.records.update({});

Input

Name	Type	Required	Description
`databaseId`	`string`	Yes	—
`tableId`	`string`	Yes	—
`recordId`	`string`	Yes	—
`record`	`object`	Yes	—

record full type

{
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`data`	`object`	Yes	—
`fields`	`object`	Yes	—
`createdAt`	`string`	Yes	—
`updatedAt`	`string`	Yes	—

data full type

{
}

fields full type

{
}

Submissions

create

submissions.create Create new form submissions Risk: write

await corsair.filloutforms.api.submissions.create({});

Input

Name	Type	Required	Description
`formId`	`string`	Yes	—
`submissions`	`object[]`	Yes	—

submissions full type

{
  questions: {
    id: string,
    value: any
  }[],
  urlParameters?: {
    id: string,
    name: string,
    value: string
  }[],
  submissionTime?: string,
  lastUpdatedAt?: string,
  scheduling?: {
  }[],
  payments?: {
  }[],
  login?: {
  }
}[]

Output

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

submissions full type

{
  submissionId: string,
  submissionTime: string,
  lastUpdatedAt?: string,
  questions: {
    id: string,
    name: string,
    type: string,
    value: any
  }[],
  calculations?: {
    id: string,
    name: string,
    type: number | text | duration,
    value: string
  }[],
  urlParameters?: {
    id: string,
    name: string,
    value: string
  }[],
  scheduling?: {
  }[],
  payments?: {
  }[],
  quiz?: {
  },
  login?: {
  }
}[]

delete

submissions.delete Delete a form submission by ID Risk: destructive

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

Input

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

Output

Name	Type	Required	Description
`deleted`	`boolean`	No	—

getById

submissions.getById Get a single submission by ID Risk: read

await corsair.filloutforms.api.submissions.getById({});

Input

Name	Type	Required	Description
`formId`	`string`	Yes	—
`submissionId`	`string`	Yes	—
`includeEditLink`	`boolean`	No	—

Output

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

submission full type

{
  submissionId: string,
  submissionTime: string,
  lastUpdatedAt?: string,
  questions: {
    id: string,
    name: string,
    type: string,
    value: any
  }[],
  calculations?: {
    id: string,
    name: string,
    type: number | text | duration,
    value: string
  }[],
  urlParameters?: {
    id: string,
    name: string,
    value: string
  }[],
  scheduling?: {
  }[],
  payments?: {
  }[],
  quiz?: {
  },
  login?: {
  }
}

list

submissions.list List form submissions with filtering and pagination Risk: read

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

Input

Name	Type	Required	Description
`formId`	`string`	Yes	—
`limit`	`number`	No	—
`afterDate`	`string`	No	—
`beforeDate`	`string`	No	—
`offset`	`number`	No	—
`status`	`finished \| in_progress`	No	—
`includeEditLink`	`boolean`	No	—
`includePreview`	`boolean`	No	—
`sort`	`asc \| desc`	No	—
`search`	`string`	No	—

Output

Name	Type	Required	Description
`responses`	`object[]`	Yes	—
`totalResponses`	`number`	Yes	—
`pageCount`	`number`	Yes	—

responses full type

{
  submissionId: string,
  submissionTime: string,
  lastUpdatedAt?: string,
  questions: {
    id: string,
    name: string,
    type: string,
    value: any
  }[],
  calculations?: {
    id: string,
    name: string,
    type: number | text | duration,
    value: string
  }[],
  urlParameters?: {
    id: string,
    name: string,
    value: string
  }[],
  scheduling?: {
  }[],
  payments?: {
  }[],
  quiz?: {
  },
  login?: {
  }
}[]

Tables

create

tables.create Create a table in a Zite database Risk: write

await corsair.filloutforms.api.tables.create({});

Input

Name	Type	Required	Description
`databaseId`	`string`	Yes	—
`name`	`string`	Yes	—
`fields`	`object[]`	Yes	—

fields full type

{
  type: single_line_text | long_text | email | url | phone_number | number | currency | percent | rating | duration | single_select | multiple_select | checkbox | date | datetime | attachments | linked_record | lookup | autonumber | source,
  name: string,
  template: {
  }
}[]

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	Yes	—
`order`	`number`	Yes	—
`primaryFieldId`	`string`	Yes	—
`fields`	`object[]`	Yes	—
`views`	`object[]`	Yes	—
`url`	`string`	Yes	—

fields full type

{
  id: string,
  name: string,
  type: string,
  template: {
  },
  order: number
}[]

views full type

{
  id: string,
  name: string,
  type: string,
  config?: {
  }
}[]

delete

tables.delete Permanently delete a Zite table Risk: destructive

await corsair.filloutforms.api.tables.delete({});

Input

Name	Type	Required	Description
`databaseId`	`string`	Yes	—
`tableId`	`string`	Yes	—

Output: empty object

update

tables.update Update Zite table properties such as name Risk: write

await corsair.filloutforms.api.tables.update({});

Input

Name	Type	Required	Description
`databaseId`	`string`	Yes	—
`tableId`	`string`	Yes	—
`name`	`string`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	Yes	—
`order`	`number`	Yes	—
`primaryFieldId`	`string`	Yes	—
`fields`	`object[]`	Yes	—
`views`	`object[]`	Yes	—
`url`	`string`	Yes	—

fields full type

{
  id: string,
  name: string,
  type: string,
  template: {
  },
  order: number
}[]

views full type

{
  id: string,
  name: string,
  type: string,
  config?: {
  }
}[]

Token

invalidate

token.invalidate Invalidate/revoke an OAuth access token Risk: destructive

await corsair.filloutforms.api.token.invalidate({});

Input

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

Output: empty object

Webhooks

createDatabase

webhooks.createDatabase Create a Zite database webhook Risk: write

await corsair.filloutforms.api.webhooks.createDatabase({});

Input

Name	Type	Required	Description
`databaseId`	`string`	Yes	—
`url`	`string`	Yes	—
`events`	`record.created \| record.updated \| record.deleted \| table.created \| table.updated \| table.deleted \| field.created \| field.updated \| field.deleted[]`	Yes	—
`tableId`	`string`	No	—

Output

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

createForm

webhooks.createForm Create a Fillout form submission webhook Risk: write

await corsair.filloutforms.api.webhooks.createForm({});

Input

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

Output

Name	Type	Required	Description
`id`	`string \| number`	Yes	—

deleteDatabase

webhooks.deleteDatabase Delete a Zite database webhook Risk: destructive

await corsair.filloutforms.api.webhooks.deleteDatabase({});

Input

Name	Type	Required	Description
`databaseId`	`string`	Yes	—
`webhookId`	`string \| number`	Yes	—

Output: empty object

listDatabase

webhooks.listDatabase List Zite database webhooks Risk: read

await corsair.filloutforms.api.webhooks.listDatabase({});

Input

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

Output

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

webhooks full type

{
  id: number,
  url: string,
  events: string[],
  active: boolean,
  tableIds?: string[] | null
}[]

removeForm

webhooks.removeForm Remove a Fillout form webhook Risk: destructive

await corsair.filloutforms.api.webhooks.removeForm({});

Input

Name	Type	Required	Description
`webhookId`	`string \| number`	Yes	—

Output: empty object

Overview

Plugins

Databases

create

delete

get

getById

Fields

create

delete

update

Forms

getFormMetadata

getForms

Oauth

authorize

Records

create

delete

getById

list

update

Submissions

create

delete

getById

list

Tables

create

delete

update

Token

invalidate

Webhooks

createDatabase

createForm

deleteDatabase

listDatabase

removeForm

​Databases

​create

​delete

​get

​getById

​Fields

​create

​delete

​update

​Forms

​getFormMetadata

​getForms

​Oauth

​authorize

​Records

​create

​delete

​getById

​list

​update

​Submissions

​create

​delete

​getById

​list

​Tables

​create

​delete

​update

​Token

​invalidate

​Webhooks

​createDatabase

​createForm

​deleteDatabase

​listDatabase

​removeForm

Databases

create

delete

get

getById

Fields

create

delete

update

Forms

getFormMetadata

getForms

Oauth

authorize

Records

create

delete

getById

list

update

Submissions

create

delete

getById

list

Tables

create

delete

update

Token

invalidate

Webhooks

createDatabase

createForm

deleteDatabase

listDatabase

removeForm