Sign in

v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB
Models

List models

Retrieves a paginated list of models with their metadata.

get/v1/models

Query parameters

baseModelIdstring

Filter models by base model ID.

connectionIdstring

Filter models by connection ID.

includeDeletedboolean

If true, include deleted models.

modelIdstring

Filter models by a specific model ID.

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

Filter by model kind.

namestring

Filter models by name.

pageSizeinteger

Specifies the number of records per page.

cursorstring

Pagination cursor

sortDirection'asc' | 'desc'

Sort direction.

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

Field to sort by.

include'activeBranches'

Comma-separated list of additional fields to include in the response.

  • activeBranches - Include active branches for each model

Response

Paginated model list