Skip to main content
POST
/
graphql#ListAccounts
List accounts
curl --request POST \
  --url 'https://clarus-api.com/graphql#ListAccounts' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "query": "query($filter: AccountFilterType) { accounts { all(filter: $filter) { edges { node { id code name is_short_pickable external_system_reference1 vat_number } } } } }"
}
'
{
  "data": {
    "accounts": {
      "all": {
        "edges": [
          {
            "node": {
              "id": "1",
              "code": "ACME",
              "name": "Acme Corporation",
              "is_short_pickable": false,
              "external_system_reference1": "ACME-EXT",
              "vat_number": "GB123456789"
            }
          }
        ]
      }
    }
  }
}

​
Query Structure

query($filter: AccountFilterType) {
  accounts {
    all(filter: $filter) {
      edges {
        node {
          id
          code
          name
          is_short_pickable
          external_system_reference1
          vat_number
        }
      }
    }
  }
}

​
Filter Argument

All filters are passed inside the filter argument. Each filter field accepts an input object with operators: 
{
  "filter": {
    "code": {
      "ilike": "ACME"
    }
  }
}

​
Available Filters

FilterInput TypeOperatorsDescription
codeStringInputTypeeq, ilike, like, in, betweenAccount code
nameStringInputTypeeq, ilike, like, in, betweenAccount name
warehouse_idIdInputTypeeq, gt, gteq, lt, lteq, in, filledAccounts associated with a warehouse
is_short_pickableBooleanInputTypeeqFilter by short pickable setting

​
Filter Operators

Input TypeOperators
StringInputTypeeq (exact), ilike (case-insensitive partial), like (case-sensitive partial), in (array match), between (range)
IntegerInputTypeeq, gt, gteq, lt, lteq, between
DatetimeInputTypeeq, from, to, between
BooleanInputTypeeq (required)
IdInputTypeeq, gt, gteq, lt, lteq, in, filled
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: AccountFilterType) { accounts { all(filter: $filter) { edges { node { id code name is_short_pickable external_system_reference1 vat_number } } } } }"

​
variables
object

Query variables including the filter object

Example:
{ "filter": { "code": { "ilike": "ACME" } } }

Response

Successful GraphQL response

​
data
object

Query result data

​
errors
object[]

GraphQL errors, if any