Skip to main content
POST
/
graphql#ListRfUsers
List RF users
curl --request POST \
  --url 'https://clarus-api.com/graphql#ListRfUsers' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "query": "query($filter: RfUserFilterType) { rf_users { all(filter: $filter) { edges { node { id name username user { id } warehouse { id code } default_rf_implementation { id } } } } } }"
}
'
{
  "data": {
    "rf_users": {
      "all": {
        "edges": [
          {
            "node": {
              "id": "55",
              "name": "Warehouse Scanner 3",
              "username": "rf_scanner_03",
              "user": {
                "id": "210"
              },
              "warehouse": {
                "id": "2",
                "code": "MAIN"
              },
              "default_rf_implementation": {
                "id": "4"
              }
            }
          }
        ]
      }
    }
  }
}

​
Query Structure

query($filter: RfUserFilterType) {
  rf_users {
    all(filter: $filter) {
      edges {
        node {
          id
          name
          username
          user { id }
          warehouse { id code }
          default_rf_implementation { id }
        }
      }
    }
  }
}

​
Filter Argument

All filters are passed inside the filter argument. Each filter field accepts an input object with operators (e.g. eq, ilike, from, to, between): 
{
  "filter": {
    "user_id": {
      "eq": "value"
    }
  }
}

​
Available Filters

FilterInput TypeOperatorsDescription
user_idIdInputTypeeq, in, gt, gteq, lt, lteq, filledLinked user ID
usernameStringInputTypeeq, ilike, like, in, betweenRF login username
user_nameStringInputTypeeq, ilike, like, in, betweenDisplay name
warehouse_idIdInputTypeeq, in, gt, gteq, lt, lteq, filledWarehouse ID
warehouse_codeStringInputTypeeq, ilike, like, in, betweenWarehouse code
default_rf_implementation_idIdInputTypeeq, in, gt, gteq, lt, lteq, filledDefault RF implementation ID
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: RfUserFilterType) { rf_users { all(filter: $filter) { edges { node { id name username user { id } warehouse { id code } default_rf_implementation { id } } } } } }"

​
variables
object

Query variables including the filter object

Example:
{
  "filter": { "username": { "ilike": "scanner" } }
}

Response

Successful GraphQL response

​
data
object

Query result data

​
errors
object[]

GraphQL errors, if any