OMomniapp
Documents

List document queries

Changed on

An organization key may pass userId to list as that member, whose access to the document then decides the response. Naming an embed user who has no live embed session is a 403.

get/api/v1/documents/{identifier}/queries

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/documents/{identifier}/queries
  • Auth
    HTTP bearer

Path parameters

identifierstring required

Document identifier (either document ID or identifier slug)

Example:abc123

Query parameters

userIdstring uuid

Target user ID (for org-scoped API keys)

Response

Every saved query in the document, in tab order — for a dashboard, app, report, or plain workbook alike. Where the document has a presentation, that layout decides which of these render, so a query here may not appear on it.

Example response

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

Changes

  • 7e53211d1c89Revision changes
    • info

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

    • info

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

  • 95080ca011e2Revision changes
    • info

      added the new optional query request parameter userId

    • info

      added the non-success response with the status