Skip to main content
POST
/
graphql#ListUsers
List users
curl --request POST \
  --url 'https://clarus-api.com/graphql#ListUsers' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "query": "query($filter: SubdomainUserFilterType) { subdomain_users { all(filter: $filter) { edges { node { id user { id name email } } } } } }"
}
'
{
  "data": {
    "subdomain_users": {
      "all": {
        "edges": [
          {
            "node": {
              "id": "1",
              "user": {
                "id": "1",
                "name": "John Smith",
                "email": "[email protected]"
              }
            }
          }
        ]
      }
    }
  }
}

​
Query Structure

query($filter: SubdomainUserFilterType) {
  subdomain_users {
    all(filter: $filter) {
      edges {
        node {
          id
          user {
            id
            name
            email
          }
        }
      }
    }
  }
}

​
Filter Argument

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

​
Available Filters

FilterInput TypeOperatorsDescription
user_emailStringInputTypeeq, ilike, like, in, betweenUser email
user_nameStringInputTypeeq, ilike, like, in, betweenUser name

​
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: SubdomainUserFilterType) { subdomain_users { all(filter: $filter) { edges { node { id user { id name email } } } } } }"

​
variables
object

Query variables including the filter object

Example:
{
  "filter": { "user_email": { "ilike": "john" } }
}

Response

Successful GraphQL response

​
data
object

Query result data

​
errors
object[]

GraphQL errors, if any