List report queries
curl --request POST \
--url 'https://clarus-api.com/graphql#ListReportQueries' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Clarus-Subdomain: <api-key>' \
--data '
{
"query": "query($filter: ReportQueryFilterType) { report_queries { all(filter: $filter) { edges { node { id name description graphql created_at updated_at } } } } }"
}
'import requests
url = "https://clarus-api.com/graphql#ListReportQueries"
payload = { "query": "query($filter: ReportQueryFilterType) { report_queries { all(filter: $filter) { edges { node { id name description graphql created_at updated_at } } } } }" }
headers = {
"Authorization": "Bearer <token>",
"X-Clarus-Subdomain": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'X-Clarus-Subdomain': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
query: 'query($filter: ReportQueryFilterType) { report_queries { all(filter: $filter) { edges { node { id name description graphql created_at updated_at } } } } }'
})
};
fetch('https://clarus-api.com/graphql#ListReportQueries', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"report_queries": {
"all": {
"edges": [
{
"node": {
"id": "1",
"name": "Stock Balance Report",
"description": "Shows current stock balances by location",
"graphql": "query { stock_balances { all { edges { node { id } } } } }",
"created_at": "2026-01-10T10:00:00Z",
"updated_at": "2026-01-10T10:00:00Z"
}
}
]
}
}
}
}{
"error": "<string>"
}Report Queries
List report queries
Retrieve report queries using GraphQL. Report queries define the data sources available for reports.
POST
/
graphql#ListReportQueries
List report queries
curl --request POST \
--url 'https://clarus-api.com/graphql#ListReportQueries' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Clarus-Subdomain: <api-key>' \
--data '
{
"query": "query($filter: ReportQueryFilterType) { report_queries { all(filter: $filter) { edges { node { id name description graphql created_at updated_at } } } } }"
}
'import requests
url = "https://clarus-api.com/graphql#ListReportQueries"
payload = { "query": "query($filter: ReportQueryFilterType) { report_queries { all(filter: $filter) { edges { node { id name description graphql created_at updated_at } } } } }" }
headers = {
"Authorization": "Bearer <token>",
"X-Clarus-Subdomain": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'X-Clarus-Subdomain': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
query: 'query($filter: ReportQueryFilterType) { report_queries { all(filter: $filter) { edges { node { id name description graphql created_at updated_at } } } } }'
})
};
fetch('https://clarus-api.com/graphql#ListReportQueries', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"report_queries": {
"all": {
"edges": [
{
"node": {
"id": "1",
"name": "Stock Balance Report",
"description": "Shows current stock balances by location",
"graphql": "query { stock_balances { all { edges { node { id } } } } }",
"created_at": "2026-01-10T10:00:00Z",
"updated_at": "2026-01-10T10:00:00Z"
}
}
]
}
}
}
}{
"error": "<string>"
}Query Structure
query($filter: ReportQueryFilterType) {
report_queries {
all(filter: $filter) {
edges {
node {
id
name
description
graphql
created_at
updated_at
}
}
}
}
}
Filter Argument
All filters are passed inside thefilter argument. Each filter field accepts an input object with operators:
{
"filter": {
"name": {
"ilike": "stock"
}
}
}
Available Filters
| Filter | Input Type | Operators | Description |
|---|---|---|---|
name | StringInputType | eq, ilike, like, in, between | Report query name |
description | StringInputType | eq, ilike, like, in, between | Report query description |
Filter Operators
| Input Type | Operators |
|---|---|
| StringInputType | eq (exact), ilike (case-insensitive partial), like (case-sensitive partial), in (array match), between (range) |
| IntegerInputType | eq, gt, gteq, lt, lteq, between |
| DatetimeInputType | eq, from, to, between |
| BooleanInputType | eq (required) |
| IdInputType | eq, gt, gteq, lt, lteq, in, filled |
Authorizations
OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.
FlowAuthorization Code
- Authorization URL
- https://clarus-api.com/oauth/authorize
- Token URL
- https://clarus-api.com/oauth/token
FlowClient Credentials
- Token URL
- https://clarus-api.com/oauth/token
The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.
Body
application/json
GraphQL query string
Example:
"query($filter: ReportQueryFilterType) { report_queries { all(filter: $filter) { edges { node { id name description graphql created_at updated_at } } } } }"
Query variables including the filter object
Show child attributes
Show child attributes
Example:
{ "filter": { "name": { "ilike": "stock" } } }