List automations
curl --request POST \
--url 'https://clarus-api.com/graphql#ListAutomations' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Clarus-Subdomain: <api-key>' \
--data '
{
"query": "query($filter: AutomationFilterType) { automations { all(filter: $filter) { edges { node { id name resource_name event enabled integration_id created_at } } } } }"
}
'import requests
url = "https://clarus-api.com/graphql#ListAutomations"
payload = { "query": "query($filter: AutomationFilterType) { automations { all(filter: $filter) { edges { node { id name resource_name event enabled integration_id created_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: AutomationFilterType) { automations { all(filter: $filter) { edges { node { id name resource_name event enabled integration_id created_at } } } } }'
})
};
fetch('https://clarus-api.com/graphql#ListAutomations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"automations": {
"all": {
"edges": [
{
"node": {
"id": "1",
"name": "Email on dispatch",
"resource_name": "goods_out",
"event": "completed",
"enabled": true,
"integration_id": null,
"created_at": "2026-01-10T12:00:00Z"
}
}
]
}
}
}
}{
"error": "<string>"
}Automations
List automations
Retrieve automations using GraphQL. Supports filtering by resource, event, status, and integration.
POST
/
graphql#ListAutomations
List automations
curl --request POST \
--url 'https://clarus-api.com/graphql#ListAutomations' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Clarus-Subdomain: <api-key>' \
--data '
{
"query": "query($filter: AutomationFilterType) { automations { all(filter: $filter) { edges { node { id name resource_name event enabled integration_id created_at } } } } }"
}
'import requests
url = "https://clarus-api.com/graphql#ListAutomations"
payload = { "query": "query($filter: AutomationFilterType) { automations { all(filter: $filter) { edges { node { id name resource_name event enabled integration_id created_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: AutomationFilterType) { automations { all(filter: $filter) { edges { node { id name resource_name event enabled integration_id created_at } } } } }'
})
};
fetch('https://clarus-api.com/graphql#ListAutomations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"automations": {
"all": {
"edges": [
{
"node": {
"id": "1",
"name": "Email on dispatch",
"resource_name": "goods_out",
"event": "completed",
"enabled": true,
"integration_id": null,
"created_at": "2026-01-10T12:00:00Z"
}
}
]
}
}
}
}{
"error": "<string>"
}Query Structure
query($filter: AutomationFilterType) {
automations {
all(filter: $filter) {
edges {
node {
id
name
resource_name
event
enabled
integration_id
created_at
}
}
}
}
}
Filter Argument
All filters are passed inside thefilter argument. Each field accepts an input object with operators.
Available Filters
| Filter | Input Type | Operators | Description |
|---|---|---|---|
name | StringInputType | eq, ilike, like, in, between | Automation name |
resource_name | ResourceNameInputType | eq | Triggering resource (e.g. goods_out) |
event | EventInputType | eq | Triggering event (e.g. completed) |
enabled | BooleanInputType | eq | Active status |
integration_id | IdInputType | eq, in, filled | Linked integration |
created_at | DatetimeInputType | eq, from, to, between | Creation time |
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: AutomationFilterType) { automations { all(filter: $filter) { edges { node { id name resource_name event enabled integration_id created_at } } } } }"
Query variables including the filter object
Show child attributes
Show child attributes
Example:
{
"filter": { "resource_name": { "eq": "goods_out" } }
}

