API

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

Things

bulkCreate

things.bulkCreate Create up to 1,000 things in one request, returning per-record results Risk: write

await corsair.bubble.api.things.bulkCreate({});

Input

Name	Type	Required	Description
`typeName`	`string`	Yes	—
`records`	`any[]`	Yes	—

Output

Name	Type	Required	Description
`count`	`number`	Yes	—
`items`	`object[]`	Yes	—

items full type

{
  status: string,
  id?: string,
  message?: string
}[]

create

things.create Create a single thing with the supplied field values Risk: write

await corsair.bubble.api.things.create({});

Input

Name	Type	Required	Description
`typeName`	`string`	Yes	—
`fields`	`any`	Yes	—

Output

Name	Type	Required	Description
`status`	`success`	Yes	—
`id`	`string`	Yes	—

delete

things.delete Permanently delete a thing by its unique ID Risk: destructive

await corsair.bubble.api.things.delete({});

Input

Name	Type	Required	Description
`typeName`	`string`	Yes	—
`thingId`	`string`	Yes	—

Output: void

get

things.get Retrieve a single thing by its unique ID Risk: read

await corsair.bubble.api.things.get({});

Input

Name	Type	Required	Description
`typeName`	`string`	Yes	—
`thingId`	`string`	Yes	—

Output

Name	Type	Required	Description
`_id`	`string`	Yes	—
`Created By`	`string`	No	—
`Created Date`	`string`	No	—
`Modified Date`	`string`	No	—

list

things.list Search and paginate things of a data type, with optional constraints and sorting Risk: read

await corsair.bubble.api.things.list({});

Input

Name	Type	Required	Description
`typeName`	`string`	Yes	—
`cursor`	`number`	No	—
`limit`	`number`	No	—
`constraints`	`object[]`	No	—
`sortField`	`string`	No	—
`descending`	`boolean`	No	—
`excludeRemaining`	`boolean`	No	—
`additionalSortFields`	`object[]`	No	—

constraints full type

{
  key: string,
  constraint_type: string,
  value?: string | number | boolean | lazy
}[]

additionalSortFields full type

{
  sortField: string,
  descending?: boolean
}[]

Output

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

response full type

{
  cursor: number,
  count: number,
  remaining?: number,
  results: {
    _id: string,
    Created By?: string,
    Created Date?: string,
    Modified Date?: string
  }[]
}

replace

things.replace Overwrite all editable fields of an existing thing (omitted fields reset to default) Risk: write

await corsair.bubble.api.things.replace({});

Input

Name	Type	Required	Description
`typeName`	`string`	Yes	—
`thingId`	`string`	Yes	—
`fields`	`any`	Yes	—

Output: void

update

things.update Change selected fields of an existing thing Risk: write

await corsair.bubble.api.things.update({});

Input

Name	Type	Required	Description
`typeName`	`string`	Yes	—
`thingId`	`string`	Yes	—
`fields`	`any`	Yes	—

Output: void

Workflows

run

workflows.run Run an API workflow with the supplied parameters (Workflow API POST) Risk: write

await corsair.bubble.api.workflows.run({});

Input

Name	Type	Required	Description
`workflowName`	`string`	Yes	—
`params`	`object`	No	—

params full type

{
}

Output

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

runGet

workflows.runGet Run an API workflow with query-string parameters (Workflow API GET) Risk: write

await corsair.bubble.api.workflows.runGet({});

Input

Name	Type	Required	Description
`workflowName`	`string`	Yes	—
`params`	`object`	No	—

params full type

{
}

Output

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

Overview

Plugins

Meta

getSwagger

Things

bulkCreate

create

delete

get

list

replace

update

Workflows

run

runGet

​Meta

​getSwagger

​Things

​bulkCreate

​create

​delete

​get

​list

​replace

​update

​Workflows

​run

​runGet

Meta

getSwagger

Things

bulkCreate

create

delete

get

list

replace

update

Workflows

run

runGet