API

Every byteforms.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 ByteForms form with custom fields and options Risk: write

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

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`body`	`object[]`	No	—
`options`	`object`	No	—

body full type

{
  component: string,
  type?: string,
  label?: string,
  id?: string,
  required?: boolean,
  placeholder?: string
}[]

options full type

{
  one_submission_per_email?: boolean,
  thank_you_message?: string,
  max_submissions?: number,
  stop_submissions_after?: string | null,
  submit_button_text?: string,
  form_width?: string,
  redirect_url?: string,
  password?: string,
  theme?: string,
  visibility?: string,
  page_behaviour?: string,
  custom_code?: string,
  draft_submissions?: boolean,
  remove_branding?: boolean,
  email_notifications?: boolean
}

Output

Name	Type	Required	Description
`data`	`object`	No	—
`status`	`string`	Yes	—

data full type

{
  id: number,
  public_id: string,
  name: string,
  body: {
    component: string,
    type?: string,
    label?: string,
    id?: string,
    required?: boolean,
    placeholder?: string
  }[],
  pages?: any | null,
  is_custom: boolean,
  options: {
    one_submission_per_email?: boolean,
    thank_you_message?: string,
    max_submissions?: number,
    stop_submissions_after?: string | null,
    submit_button_text?: string,
    form_width?: string,
    redirect_url?: string,
    password?: string,
    theme?: string,
    visibility?: string,
    page_behaviour?: string,
    custom_code?: string,
    draft_submissions?: boolean,
    remove_branding?: boolean,
    email_notifications?: boolean
  },
  user_id: number,
  created_at: string,
  updated_at: string,
  deleted_at?: string | null
}

delete

forms.delete Delete a ByteForms form by its numeric or public ID Risk: destructive

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

Input

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

Output

Name	Type	Required	Description
`data`	`boolean`	No	—
`status`	`string`	Yes	—

get

forms.get Retrieve a single ByteForms form definition by ID Risk: read

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

Input

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

Output

Name	Type	Required	Description
`data`	`object`	Yes	—
`status`	`string`	Yes	—

data full type

{
  id: number,
  public_id: string,
  name: string,
  body: {
    component: string,
    type?: string,
    label?: string,
    id?: string,
    required?: boolean,
    placeholder?: string
  }[],
  pages?: any | null,
  is_custom: boolean,
  options: {
    one_submission_per_email?: boolean,
    thank_you_message?: string,
    max_submissions?: number,
    stop_submissions_after?: string | null,
    submit_button_text?: string,
    form_width?: string,
    redirect_url?: string,
    password?: string,
    theme?: string,
    visibility?: string,
    page_behaviour?: string,
    custom_code?: string,
    draft_submissions?: boolean,
    remove_branding?: boolean,
    email_notifications?: boolean
  },
  user_id: number,
  created_at: string,
  updated_at: string,
  deleted_at?: string | null
}

list

forms.list List all ByteForms forms created by the authenticated user Risk: read

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

Input: empty object Output

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

data full type

{
  id: number,
  public_id: string,
  name: string,
  body: {
    component: string,
    type?: string,
    label?: string,
    id?: string,
    required?: boolean,
    placeholder?: string
  }[],
  pages?: any | null,
  is_custom: boolean,
  options: {
    one_submission_per_email?: boolean,
    thank_you_message?: string,
    max_submissions?: number,
    stop_submissions_after?: string | null,
    submit_button_text?: string,
    form_width?: string,
    redirect_url?: string,
    password?: string,
    theme?: string,
    visibility?: string,
    page_behaviour?: string,
    custom_code?: string,
    draft_submissions?: boolean,
    remove_branding?: boolean,
    email_notifications?: boolean
  },
  user_id: number,
  created_at: string,
  updated_at: string,
  deleted_at?: string | null
}[]

responses

forms.responses Retrieve paginated responses submitted to a ByteForms form Risk: read

await corsair.byteforms.api.forms.responses({});

Input

Name	Type	Required	Description
`formId`	`string`	Yes	—
`limit`	`number`	No	—
`order`	`asc \| desc`	No	—
`query`	`string`	No	—
`after`	`string`	No	—
`before`	`string`	No	—

Output

Name	Type	Required	Description
`count`	`number`	Yes	—
`cursor`	`object`	Yes	—
`data`	`object`	Yes	—
`status`	`string`	Yes	—

cursor full type

{
  after?: string | null,
  before?: string | null
}

data full type

{
  id: number,
  form_id: number,
  response: {
  },
  options?: {
    ip?: string
  },
  created_at: string,
  updated_at: string,
  deleted_at?: string | null
}[] | null

Overview

Plugins

Forms

create

delete

get

list

responses

​Forms

​create

​delete

​get

​list

​responses

Forms

create

delete

get

list

responses