API referenceQueries

Get query status

Get the status of an asynchronous query. If the status is COMPLETE, this request also returns the query response.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

query_idstringRequired

The unique identifier of the query. This value is returned by a Run query request.

Headers

IB-ContextstringOptional
Specify whether to use your community account or organization account to complete the request. To use your community account, define as your user ID. To use your organization account, define as your organization ID. If unspecified, defaults to community account context. See [Authorization and context identification](/api-sdk/authorization#ib-context-header) for details.

Response

Query result successfully retrieved.
query_idstring
The unique identifier of the query.
statusenum
Status of the query.
Allowed values:
resultslist of objects or null

The query response. Returned only if the query status is COMPLETE.

errorstring or null

Present only if the status is FAILED. Contains a message with information about the source of the execution error, such as "message":"Invalid query uuid passed".