Skip to main content
POST
/
graphql#ListChargeBaskets
List charge baskets
curl --request POST \
  --url 'https://clarus-api.com/graphql#ListChargeBaskets' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "query": "query($filter: ChargeBasketFilterType) { charge_baskets { all(filter: $filter) { edges { node { id status invoice_status start_at end_at } } } } }"
}
'
{
  "data": {
    "charge_baskets": {
      "all": {
        "edges": [
          {
            "node": {
              "id": "1",
              "status": "OPEN",
              "invoice_status": "not_invoiced",
              "start_at": "2026-03-01T00:00:00Z",
              "end_at": null
            }
          }
        ]
      }
    }
  }
}

​
Query Structure

query($filter: ChargeBasketFilterType) {
  charge_baskets {
    all(filter: $filter) {
      edges {
        node {
          id
          status
          invoice_status
          start_at
          end_at
        }
      }
    }
  }
}

​
Filter Argument

All filters are passed inside the filter argument. Each filter field accepts an input object with operators: 
{
  "filter": {
    "status": {
      "eq": "OPEN"
    }
  }
}

​
Available Filters

FilterInput TypeOperatorsDescription
idIdInputTypeeq, gt, gteq, lt, lteq, in, filledCharge basket ID
statusStringInputTypeeq, ilike, like, in, betweenBasket status (OPEN/CLOSED)
invoice_statusStringInputTypeeq, ilike, like, in, betweenInvoice status
start_atDatetimeInputTypeeq, from, to, betweenBasket start date
end_atDatetimeInputTypeeq, from, to, betweenBasket end date
account_idIdInputTypeeq, gt, gteq, lt, lteq, in, filledAssociated account

​
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: ChargeBasketFilterType) { charge_baskets { all(filter: $filter) { edges { node { id status invoice_status start_at end_at } } } } }"

​
variables
object

Query variables including the filter object

Example:
{ "filter": { "status": { "eq": "OPEN" } } }

Response

Successful GraphQL response

​
data
object

Query result data

​
errors
object[]

GraphQL errors, if any