Skip to main content
GET
/
v1
/
documents
/
{documentId}
/
queries
Get document queries
curl --request GET \
  --url https://{instance}.omniapp.co/api/v1/documents/{documentId}/queries \
  --header 'Authorization: Bearer <token>'
{
  "queries": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "url": "https://org.omni.co/w/abc123?key=1",
      "query": {}
    }
  ]
}
Check out the Running document queries with APIs guide to learn how to programmatically run the queries you retrieve with this API.

Authorizations

​
Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

​
documentId
string
required

The unique identifier of the document. This can be retrieved by:

  • Opening the document settings: Navigate to File > Document settings and click Settings. The Identifier field contains the document ID.
  • Using the dashboard's URL: The string after /dashboards/ is the identifier (e.g., https://myorg.omniapp.co/dashboards/12db1a0a)

Response

Queries retrieved successfully

​
queries
object[]

An array of queries used in the document