API - Corsair

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

Action Classes

create

actionClasses.create Create an action class Risk: write

await corsair.formbricks.api.actionClasses.create({});

Input

Name	Type	Required	Description
`workspaceId`	`string`	Yes	—
`name`	`string`	Yes	—
`description`	`string`	No	—
`type`	`code \| noCode`	Yes	—
`key`	`string`	No	—
`noCodeConfig`	`object`	No	—

noCodeConfig full type

{
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`description`	`string`	No	—
`type`	`string`	No	—
`key`	`string`	No	—
`workspaceId`	`string`	No	—
`noCodeConfig`	`any`	No	—
`createdAt`	`string`	No	—
`updatedAt`	`string`	No	—

list

actionClasses.list List the action classes that can trigger a survey Risk: read

await corsair.formbricks.api.actionClasses.list({});

Input: empty object Output: object[]

Output full type

{
  id: string,
  name?: string | null,
  description?: string | null,
  type?: string | null,
  key?: string | null,
  workspaceId?: string | null,
  noCodeConfig?: any,
  createdAt?: string | null,
  updatedAt?: string | null
}[]

Client

contactsState

client.contactsState Read a respondent’s state, creating the contact if the userId is new Risk: write

await corsair.formbricks.api.client.contactsState({});

Input

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

Output

Name	Type	Required	Description
`state`	`object`	No	—

state full type

{
  data?: any,
  expiresAt?: string | null
}

createDisplay

client.createDisplay Record that a survey was displayed to someone Risk: write

await corsair.formbricks.api.client.createDisplay({});

Input

Name	Type	Required	Description
`workspaceId`	`string`	Yes	—
`surveyId`	`string`	Yes	—
`userId`	`string`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`surveyId`	`string`	No	—
`contactId`	`string`	No	—

createUser

client.createUser Create a client user Risk: write

await corsair.formbricks.api.client.createUser({});

Input

Name	Type	Required	Description
`workspaceId`	`string`	Yes	—
`userId`	`string`	Yes	—
`attributes`	`object`	No	—

attributes full type

{
}

Output

Name	Type	Required	Description
`state`	`object`	No	—

state full type

{
  data?: any,
  expiresAt?: string | null
}

environment

client.environment Read the client environment bundle for a workspace Risk: read

await corsair.formbricks.api.client.environment({});

Input

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

Output

Name	Type	Required	Description
`data`	`any`	No	—
`expiresAt`	`string`	No	—

identifyUser

client.identifyUser Create or identify a client user Risk: write

await corsair.formbricks.api.client.identifyUser({});

Input

Name	Type	Required	Description
`workspaceId`	`string`	Yes	—
`userId`	`string`	Yes	—
`attributes`	`object`	No	—

attributes full type

{
}

Output

Name	Type	Required	Description
`state`	`object`	No	—

state full type

{
  data?: any,
  expiresAt?: string | null
}

Contact Attribute Keys

create

contactAttributeKeys.create Create a contact attribute key Risk: write

await corsair.formbricks.api.contactAttributeKeys.create({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`key`	`string`	No	—
`name`	`string`	No	—
`description`	`string`	No	—
`type`	`string`	No	—
`dataType`	`string`	No	—
`isUnique`	`boolean`	No	—
`workspaceId`	`string`	No	—
`createdAt`	`string`	No	—
`updatedAt`	`string`	No	—

delete

contactAttributeKeys.delete Delete a contact attribute key Risk: destructive

await corsair.formbricks.api.contactAttributeKeys.delete({});

Input

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

Output

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

get

contactAttributeKeys.get Get a single contact attribute key Risk: read

await corsair.formbricks.api.contactAttributeKeys.get({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`key`	`string`	No	—
`name`	`string`	No	—
`description`	`string`	No	—
`type`	`string`	No	—
`dataType`	`string`	No	—
`isUnique`	`boolean`	No	—
`workspaceId`	`string`	No	—
`createdAt`	`string`	No	—
`updatedAt`	`string`	No	—

getClass

contactAttributeKeys.getClass Get an attribute key under the catalog’s former “attribute class” name - same route as contactAttributeKeys.get Risk: read

await corsair.formbricks.api.contactAttributeKeys.getClass({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`key`	`string`	No	—
`name`	`string`	No	—
`description`	`string`	No	—
`type`	`string`	No	—
`dataType`	`string`	No	—
`isUnique`	`boolean`	No	—
`workspaceId`	`string`	No	—
`createdAt`	`string`	No	—
`updatedAt`	`string`	No	—

list

contactAttributeKeys.list List the contact attribute keys a workspace defines Risk: read

await corsair.formbricks.api.contactAttributeKeys.list({});

Input

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

Output: object[]

Output full type

{
  id: string,
  key?: string | null,
  name?: string | null,
  description?: string | null,
  type?: string | null,
  dataType?: string | null,
  isUnique?: boolean | null,
  workspaceId?: string | null,
  createdAt?: string | null,
  updatedAt?: string | null
}[]

listClasses

contactAttributeKeys.listClasses List attribute keys under the catalog’s former “attribute class” name - same route as contactAttributeKeys.list Risk: read

await corsair.formbricks.api.contactAttributeKeys.listClasses({});

Input

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

Output: object[]

Output full type

{
  id: string,
  key?: string | null,
  name?: string | null,
  description?: string | null,
  type?: string | null,
  dataType?: string | null,
  isUnique?: boolean | null,
  workspaceId?: string | null,
  createdAt?: string | null,
  updatedAt?: string | null
}[]

update

contactAttributeKeys.update Update a contact attribute key’s definition - not any contact’s values Risk: write

await corsair.formbricks.api.contactAttributeKeys.update({});

Input

Name	Type	Required	Description
`contactAttributeKeyId`	`string`	Yes	—
`name`	`string`	No	—
`description`	`string`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`key`	`string`	No	—
`name`	`string`	No	—
`description`	`string`	No	—
`type`	`string`	No	—
`dataType`	`string`	No	—
`isUnique`	`boolean`	No	—
`workspaceId`	`string`	No	—
`createdAt`	`string`	No	—
`updatedAt`	`string`	No	—

Contact Attributes

list

contactAttributes.list List contact attribute values across contacts Risk: read

await corsair.formbricks.api.contactAttributes.list({});

Input: empty object Output: object[]

Output full type

{
  id: string,
  attributeKeyId?: string | null,
  contactId?: string | null,
  value?: string | null,
  valueNumber?: number | null,
  valueDate?: string | null,
  createdAt?: string | null,
  updatedAt?: string | null
}[]

Contacts

create

contacts.create Create a contact Risk: write

await corsair.formbricks.api.contacts.create({});

Input

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

attributes full type

{
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`workspaceId`	`string`	No	—
`attributes`	`any`	No	—
`createdAt`	`string`	No	—
`updatedAt`	`string`	No	—

delete

contacts.delete Delete a contact, removing a respondent’s identity Risk: destructive

await corsair.formbricks.api.contacts.delete({});

Input

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

Output

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

get

contacts.get Get a single contact Risk: read

await corsair.formbricks.api.contacts.get({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`workspaceId`	`string`	No	—
`attributes`	`any`	No	—
`createdAt`	`string`	No	—
`updatedAt`	`string`	No	—

getPerson

contacts.getPerson Get a contact under the catalog’s former “person” name - same route as contacts.get Risk: read

await corsair.formbricks.api.contacts.getPerson({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`workspaceId`	`string`	No	—
`attributes`	`any`	No	—
`createdAt`	`string`	No	—
`updatedAt`	`string`	No	—

list

contacts.list List the contacts in a workspace Risk: read

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

Input: empty object Output: object[]

Output full type

{
  id: string,
  workspaceId?: string | null,
  attributes?: any,
  createdAt?: string | null,
  updatedAt?: string | null
}[]

listPeople

contacts.listPeople List contacts under the catalog’s former “people” name - same route as contacts.list Risk: read

await corsair.formbricks.api.contacts.listPeople({});

Input: empty object Output: object[]

Output full type

{
  id: string,
  workspaceId?: string | null,
  attributes?: any,
  createdAt?: string | null,
  updatedAt?: string | null
}[]

updateAttributes

contacts.updateAttributes Set a contact’s attribute values by userId, creating the contact if it is new Risk: write

await corsair.formbricks.api.contacts.updateAttributes({});

Input

Name	Type	Required	Description
`workspaceId`	`string`	Yes	—
`userId`	`string`	Yes	—
`attributes`	`object`	Yes	—

attributes full type

{
}

Output

Name	Type	Required	Description
`state`	`object`	No	—

state full type

{
  data?: any,
  expiresAt?: string | null
}

uploadBulk

contacts.uploadBulk Create many contacts in one request Risk: write

await corsair.formbricks.api.contacts.uploadBulk({});

Input

Name	Type	Required	Description
`workspaceId`	`string`	Yes	—
`contacts`	`object[]`	Yes	—

contacts full type

{
  attributes: {
    attributeKey: {
      key: string,
      name?: string
    },
    value: string
  }[]
}[]

Output

Name	Type	Required	Description
`status`	`string`	No	—
`message`	`string`	No	—