API

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

Apps

getAll

apps.getAll List Workiom apps via GET /api/services/app/Apps/GetAll Risk: read

await corsair.workiom.api.apps.getAll({});

Input: empty object Output

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

items full type

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

Lists

get

lists.get Get a list’s fields, views, and filters via GET /api/services/app/Lists/Get Risk: read

await corsair.workiom.api.lists.get({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`expand`	`Fields \| Views \| Filters[]`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`appId`	`string`	No	—
`name`	`string`	Yes	—
`description`	`string`	No	—
`fields`	`object[]`	No	—
`views`	`object[]`	No	—
`filters`	`object[]`	No	—

fields full type

{
  id: number,
  name: string,
  description?: string,
  dataType?: number
}[]

views full type

{
  id?: number,
  name?: string,
  listId?: string,
  isDefault?: boolean,
  viewType?: number,
  filters?: {
    fieldId: number,
    operator: number,
    value?: any
  }[]
}[]

filters full type

{
  fieldId: number,
  operator: number,
  value?: any
}[]

getAll

lists.getAll Get all lists in a Workiom app via GET /api/services/app/Lists/GetAll Risk: read

await corsair.workiom.api.lists.getAll({});

Input

Name	Type	Required	Description
`appId`	`string`	Yes	Workiom app UUID from the app URL or Apps/GetAll

Output

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

items full type

{
  id: string,
  appId?: string,
  name: string,
  description?: string,
  fields?: {
    id: number,
    name: string,
    description?: string,
    dataType?: number
  }[],
  views?: {
    id?: number,
    name?: string,
    listId?: string,
    isDefault?: boolean,
    viewType?: number,
    filters?: {
      fieldId: number,
      operator: number,
      value?: any
    }[]
  }[],
  filters?: {
    fieldId: number,
    operator: number,
    value?: any
  }[]
}[]

Records

create

records.create Create a list record via POST /api/services/app/Data/Create?listId= Risk: write

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

Input

Name	Type	Required	Description
`listId`	`string`	Yes	—
`record`	`object`	Yes	Field ID keys to values, per list metadata

record full type

{
}

Output

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

getAll

records.getAll Get list records with sort, pagination, and filters via POST /api/services/app/Data/All Risk: read

await corsair.workiom.api.records.getAll({});

Input

Name	Type	Required	Description
`listId`	`string`	Yes	—
`sorting`	`string`	No	Official sort string, e.g. ‘11284 ASC’ or ‘11284 DESC’
`maxResultCount`	`number`	No	—
`skipCount`	`number`	No	—
`filters`	`object[]`	No	—

filters full type

{
  fieldId: number,
  operator: number,
  value?: any
}[]

Output

Name	Type	Required	Description
`items`	`object[]`	Yes	—
`totalCount`	`number`	Yes	—
`summary`	`object`	No	—

items full type

{
  _id?: string
}[]

summary full type

{
}

update

records.update Replace a list record via PUT /api/services/app/Data/Update?listId=&id= Risk: write

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

Input

Name	Type	Required	Description
`listId`	`string`	Yes	—
`id`	`string`	Yes	—
`record`	`object`	Yes	Full record body; PUT replaces the record

record full type

{
}

Output

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

Overview

Plugins

Apps

getAll

Lists

get

getAll

Records

create

getAll

update

​Apps

​getAll

​Lists

​get

​getAll

​Records

​create

​getAll

​update

Apps

getAll

Lists

get

getAll

Records

create

getAll

update