API

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

Documents

list

documents.list Retrieve a list of documents from a Boloforms workspace, with optional filtering and pagination Risk: read

await corsair.boloforms.api.documents.list({});

Input

Name	Type	Required	Description
`workspaceId`	`string`	Yes	—
`query`	`string`	No	—
`sortOrder`	`string`	No	—
`limit`	`string`	No	—
`documentId`	`string`	No	—
`dateTo`	`string`	No	—
`dateFrom`	`string`	No	—
`page`	`string`	No	—
`sortBy`	`string`	No	—
`filter`	`string`	No	—

Output

Name	Type	Required	Description
`documents`	`object[]`	Yes	—
`message`	`string`	No	—
`formCount`	`number`	No	—
`documentsCount`	`number`	No	—
`pagination`	`object`	No	—

documents full type

{
  documentId: string,
  name?: string,
  documentName?: string,
  status?: string,
  signingType?: string,
  createdAt?: string,
  updatedAt?: string
}[]

pagination full type

{
  currentPage?: number,
  totalPages?: number,
  totalDocuments?: number
}

Overview

Plugins

Documents

list

​Documents

​list

Documents

list