OMomni
Documents

List document queries

Changed on

Retrieve queries associated with a document by its identifier. The specified document must be a saved document with at least one query in the workbook.

An organization API key can pass userId to list the queries as that member instead of the key's creator — the member's access to the document decides what's returned. A user-scoped key can only ever act as itself.

get/v1/documents/{documentId}/queries

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/documents/{documentId}/queries
  • Auth
    HTTP bearer

Path parameters

documentIdstring required

The unique identifier of the document. This can be retrieved by opening File > Document settings and clicking Settings. The Identifier field contains the document ID.

Query parameters

userIdstring uuid

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

Response

Every saved query in the document, in tab order.

Note that when a document has a presentation (dashboard or app), the layout decides which queries are rendered. This means that this response may include queries that aren't included in a layout.

Example response

{
  "queries": [
    {
      "url": "https://org.omni.co/w/abc123?key=1"
    }
  ]
}

Changes

  • 43290040f88fRevision changes
    • breaking

      the // response's property format changed from uuid to no format for status

    • breaking

      the // response's property type changed from object to no type for status

    • warning

      the optional response header Deprecation removed for the status 200

    • warning

      the optional response header Link removed for the status 200

    • warning

      the optional response header Sunset removed for the status 200

    • info

      api operation id getDocumentQueries removed and replaced with documentsGetQueries

    • info

      endpoint reactivated

    • info

      added the new optional query request parameter userId

    • info

      added the non-success response with the status

    • 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

      the response property became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

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