OMomni
Models

List models

Changed on

Retrieves a paginated list of models with their metadata.

An Organization API key can pass userId to list models as that member sees them, instead of every model in the organization. A Personal Access Token can only ever act as the calling user.

Branches included via include=activeBranches are not filtered to the named member's access.

get/v1/models

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/models
  • Auth
    HTTP bearer

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
Example:20

Number of results per page

pageSizeinteger
Example:20

Number of results per page

explorableboolean

When true, returns only shared models (modelKind: SHARED) and shared extension models (modelKind: SHARED_EXTENSION) that can be used as a workbook base (allowAsWorkbookBase: true).

sortDirection'asc' | 'desc'

Direction for sorting results:

  • asc - Ascending order (A-Z, 0-9)
  • desc - Descending order (Z-A, 9-0)
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
userIdstring uuid

Organization API key required. The membership ID of the user to act as.

Response

Paginated model list

Changes

  • 43290040f88fRevision changes
    • breaking

      for the query request parameter sortDirection, default value desc was removed

    • warning

      for the query request parameter pageSize, the max was set to 100.00

    • warning

      for the query request parameter pageSize, the min was set to 1.00

    • warning

      deleted the query request parameter cursor

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional query request parameter explorable

    • info

      added the new optional query request parameter pageSize

    • info

      added the new optional query request parameter userId

    • info

      added the non-success response with the status

    • info

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

    • info

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

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status