GET
Get all schemas
Request · Guide: Extract fields
The response will contain a list of all schemas that are available for the current user in the current workspace.Pass the cursor query parameter (empty for the first page) to use cursor pagination: the response envelope becomes { data, pagination: { limit, nextCursor, hasMore } }. Follow nextCursor until hasMore is false; keep the same sort and filter parameters for every page of a walk.The schemas field is an array of schemas. Each schema contains the following fields:
  • id: The ID of the schema. This is the unique identifier for the schema.
  • fields: An array of fields. Each field contains the following fields:
    • id: The ID of the field. This is the unique identifier for the field.
  • blueprintId: The ID of the blueprint that the schema is associated with.
  • originalSchemaId: The ID of the original schema that the schema is based on.
  • schemaHistoryId: The ID of the schema history that the schema is associated with.
  • schemaHistoryVersionNumber: The version number of the schema history that the schema is associated with. This is a number that increments every time a new version of the schema is created.
  • fileId: The ID of the file that the schema is associated with.
  • blueprintMode: The mode of the blueprint that the schema is associated with. This is either user or system.
  • schemaType: The type of the schema. This is either custom or system.
  • state: The state of the schema. This is either active or inactive.
  • usageApprovalState: The state of the usage approval of the schema. This can be either APPROVED, PENDING, or REJECTED.
  • schemaOverrideType: The type of the schema override. This can be either OVERRIDE or DEFAULT.
  • aiSchemaVersion: The version of the AI schema that the schema is associated with.
  • createdAt: The date and time when the schema was created.
  • updatedAt: The date and time when the schema was last updated.
  • deletedAt: The date and time when the schema was deleted.
  • deletedBy: The ID of the user who deleted the schema.

Authorizations

​
x-api-key
string
header
required

API key for authentication

Query Parameters

​
schemaIds
string

Schema Ids

Example:

"649e2d2d2d2d2d2d2d2d2d2d"

​
uploadIds
string

Upload Ids

Example:

"649e2d2d2d2d2d2d2d2d2d2d"

​
page
number
default:1

Page number

Example:

1

​
limit
number
default:100

Number of items per page

Example:

100

​
sortBy
string
default:createdAt

Field to sort by

Example:

"createdAt"

​
sortOrder
enum<string>
default:ASC

Sort direction

Available options:
ASC,
DESC
Example:

"ASC"

​
cursor
string

Opaque pagination cursor. Provide the parameter (empty value for the first page) to switch to cursor pagination: the response becomes { data, pagination: { limit, nextCursor, hasMore } } with default limit 50 (max 100). Omit it entirely for legacy page/limit pagination. In cursor mode sortBy must be one of createdAt, updatedAt, _id, and cursors are bound to the sortBy/sortOrder they were minted with.

Response

The list of schemas. Offset mode (default) returns {schemas, count, currentPage}; cursor mode (when the cursor query parameter is present) returns {data, pagination}.

​
schemas
object[]
required
​
count
number
required

Total number of matching schemas

​
currentPage
number
required