Skip to main content
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 } } } } }"
}
'
{
  "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"
            }
          }
        ]
      }
    }
  }
}

​
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 the filter argument. Each field accepts an input object with operators.

​
Available Filters

FilterInput TypeOperatorsDescription
nameStringInputTypeeq, ilike, like, in, betweenAutomation name
resource_nameResourceNameInputTypeeqTriggering resource (e.g. goods_out)
eventEventInputTypeeqTriggering event (e.g. completed)
enabledBooleanInputTypeeqActive status
integration_idIdInputTypeeq, in, filledLinked integration
created_atDatetimeInputTypeeq, from, to, betweenCreation time
More fields and filters available via GraphQL introspection.

Authorizations

​
Authorization
string
header
required

OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.

​
X-Clarus-Subdomain
string
header
required

The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.

Body

application/json
​
query
string<textarea>
required

GraphQL query string

Example:

"query($filter: AutomationFilterType) { automations { all(filter: $filter) { edges { node { id name resource_name event enabled integration_id created_at } } } } }"

​
variables
object

Query variables including the filter object

Example:
{
  "filter": { "resource_name": { "eq": "goods_out" } }
}

Response

Successful GraphQL response

​
data
object

Query result data

​
errors
object[]

GraphQL errors, if any