OMomniapp
Models

List models

Changed on

With userId, models are listed as that user sees them (the activeBranches include is not filtered); without it an org key lists every model. A user-scoped key may only name itself.

get/api/v1/models

Request

  • Base URL
    https://omniapp.co (the document declares no server; this is the origin it was published from)
  • URL
    https://omniapp.co/api/v1/models
  • Auth
    HTTP bearer

Query parameters

baseModelIdstring uuid

Filter by base model ID

connectionIdstring uuid

Filter by connection ID

cursorstring

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.

includestring

Comma-separated list of fields to include. Supported: activeBranches

Example:activeBranches
includeDeleted'0' | '1' | 'true' | 'false'

Include deleted models

modelIdstring uuid

Filter by specific model ID

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

Filter by model kind

namestring

Filter by model name

pageSizeinteger

Number of results per page (1-100, integer)

Example:20
sortDirection'asc' | 'desc'

Sort direction for results

Example:desc
sortField'name' | 'modelKind' | 'connectionId' | 'baseModelId' | 'createdAt' | 'updatedAt'

Field to sort by

userIdstring uuid

Target user ID (for org-scoped API keys)

Response

Paginated list of models

Changes

  • 5775a7ba4b2fRevision changes
    • info

      added the required property //// to the response with the status

  • d2a8175f2dd3Revision changes
    • info

      added the new optional query request parameter userId

    • info

      added the non-success response with the status