Skip to main content
POST
/
graphql#ListDocuments
List documents
curl --request POST \
  --url 'https://clarus-api.com/graphql#ListDocuments' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "query": "query($filter: DocumentFilterType) { documents { all(filter: $filter) { edges { node { id file_name file_type category status created_at updated_at } } } } }"
}
'
{
  "data": {
    "documents": {
      "all": {
        "edges": [
          {
            "node": {
              "id": "1",
              "file_name": "stock-report-2026-03.pdf",
              "file_type": "pdf",
              "category": "report",
              "status": "completed",
              "created_at": "2026-03-10T08:00:00Z",
              "updated_at": "2026-03-10T08:01:00Z"
            }
          }
        ]
      }
    }
  }
}

​
Query Structure

query($filter: DocumentFilterType) {
  documents {
    all(filter: $filter) {
      edges {
        node {
          id
          file_name
          file_type
          category
          status
          created_at
          updated_at
        }
      }
    }
  }
}

​
Filter Argument

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

​
Available Filters

FilterInput TypeOperatorsDescription
file_nameStringInputTypeeq, ilike, like, in, betweenDocument file name
categoryStringInputTypeeq, ilike, like, in, betweenDocument category
statusStringInputTypeeq, ilike, like, in, betweenDocument status
file_typeStringInputTypeeq, ilike, like, in, betweenFile type (e.g. pdf, csv)

​
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: DocumentFilterType) { documents { all(filter: $filter) { edges { node { id file_name file_type category status created_at updated_at } } } } }"

​
variables
object

Query variables including the filter object

Example:
{
  "filter": { "category": { "eq": "report" } }
}

Response

Successful GraphQL response

​
data
object

Query result data

​
errors
object[]

GraphQL errors, if any