Sign in

d09b4a347e87

latestOpenAPI 3.1.02026-08-14211332770.5 KB
Models

List models

get/api/v1/models

Query parameters

baseModelIdstring uuid

Filter by base model ID

Filter by base model ID

connectionIdstring uuid

Filter by connection ID

Filter by connection ID

cursorstring

Cursor for pagination

Cursor for pagination

explorable'0' | '1' | 'true' | 'false'

When true, returns only models that can be explored directly: shared models, and shared extension models the org allows as a workbook base. Combining with a modelKind other than SHARED or SHARED_EXTENSION is a 400.

When true, returns only models that can be explored directly: shared models, and shared extension models the org allows as a workbook base. Combining with a modelKind other than SHARED or SHARED_EXTENSION is a 400.

includestring

Comma-separated list of fields to include (e.g., activeBranches)

Example:activeBranches

Comma-separated list of fields to include (e.g., activeBranches)

includeDeleted'0' | '1' | 'true' | 'false'

Include deleted models

Include deleted models

modelIdstring uuid

Filter by specific model ID

Filter by specific model ID

modelKind'SCHEMA' | 'SHARED' | 'SHARED_EXTENSION' | 'BRANCH' | 'WORKBOOK' | 'QUERY'

Filter by model kind

Filter by model kind

namestring

Filter by model name

Filter by model name

pageSizeinteger

Number of results per page

Example:20

Number of results per page

sortDirection'asc' | 'desc'

Sort direction

Sort direction

sortField'name' | 'modelKind' | 'connectionId' | 'baseModelId' | 'createdAt' | 'updatedAt'

Field to sort by

Field to sort by

Response

Paginated list of models