List import configurations

curl --request POST \
  --url 'https://clarus-api.com/graphql#ListImportConfigurations' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "query": "query($filter: ImportConfigurationFilterType) { import_configurations { all(filter: $filter) { edges { node { id name parser failure_strategy created_at } } } } }"
}
'

import requests

url = "https://clarus-api.com/graphql#ListImportConfigurations"

payload = { "query": "query($filter: ImportConfigurationFilterType) { import_configurations { all(filter: $filter) { edges { node { id name parser failure_strategy created_at } } } } }" }
headers = {
    "Authorization": "Bearer <token>",
    "X-Clarus-Subdomain": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'X-Clarus-Subdomain': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    query: 'query($filter: ImportConfigurationFilterType) { import_configurations { all(filter: $filter) { edges { node { id name parser failure_strategy created_at } } } } }'
  })
};

fetch('https://clarus-api.com/graphql#ListImportConfigurations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "import_configurations": {
      "all": {
        "edges": [
          {
            "node": {
              "id": "1",
              "name": "Acme Orders CSV",
              "parser": "csv",
              "failure_strategy": "skip_resource",
              "created_at": "2026-01-10T12:00:00Z"
            }
          }
        ]
      }
    }
  }
}

{
  "error": "<string>"
}

POST

graphql#ListImportConfigurations

List import configurations

curl --request POST \
  --url 'https://clarus-api.com/graphql#ListImportConfigurations' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "query": "query($filter: ImportConfigurationFilterType) { import_configurations { all(filter: $filter) { edges { node { id name parser failure_strategy created_at } } } } }"
}
'

import requests

url = "https://clarus-api.com/graphql#ListImportConfigurations"

payload = { "query": "query($filter: ImportConfigurationFilterType) { import_configurations { all(filter: $filter) { edges { node { id name parser failure_strategy created_at } } } } }" }
headers = {
    "Authorization": "Bearer <token>",
    "X-Clarus-Subdomain": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'X-Clarus-Subdomain': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    query: 'query($filter: ImportConfigurationFilterType) { import_configurations { all(filter: $filter) { edges { node { id name parser failure_strategy created_at } } } } }'
  })
};

fetch('https://clarus-api.com/graphql#ListImportConfigurations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "import_configurations": {
      "all": {
        "edges": [
          {
            "node": {
              "id": "1",
              "name": "Acme Orders CSV",
              "parser": "csv",
              "failure_strategy": "skip_resource",
              "created_at": "2026-01-10T12:00:00Z"
            }
          }
        ]
      }
    }
  }
}

{
  "error": "<string>"
}

Query Structure

query($filter: ImportConfigurationFilterType) {
  import_configurations {
    all(filter: $filter) {
      edges {
        node {
          id
          name
          parser
          failure_strategy
          created_at
        }
      }
    }
  }
}

Filter Argument

All filters are passed inside the filter argument. Each field accepts an input object with operators.

Available Filters

Filter	Input Type	Operators	Description
`name`	StringInputType	`eq`, `ilike`, `like`, `in`, `between`	Configuration name
`parser`	ParserInputType	`eq`	xml, headless_csv, csv, edi, txt
`failure_strategy`	FailureStrategyInputType	`eq`	skip_resource or abort
`created_at`	DatetimeInputType	`eq`, `from`, `to`, `between`	Creation time

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.

FlowAuthorization Code

Authorization URL: https://clarus-api.com/oauth/authorize
Token URL: https://clarus-api.com/oauth/token

FlowClient Credentials

Token URL: https://clarus-api.com/oauth/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: ImportConfigurationFilterType) { import_configurations { all(filter: $filter) { edges { node { id name parser failure_strategy created_at } } } } }"

variables

object

Query variables including the filter object

Show child attributes

Example:

{ "filter": { "parser": { "eq": "csv" } } }

Response

Successful GraphQL response

data

object

Query result data

Show child attributes

errors

object[]

GraphQL errors, if any

​Query Structure

​Filter Argument

​Available Filters

Authorizations

Body

Response

Query Structure

Filter Argument

Available Filters