Skip to main content
POST
/
graphql#ListImportTemplates
List import templates
curl --request POST \
  --url 'https://clarus-api.com/graphql#ListImportTemplates' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "query": "query($filter: ImportTemplateFilterType) { import_templates { all(filter: $filter) { edges { node { id file_regexp template_type account { id code } ftp_user { id name } mapping_group { id } } } } } }"
}
'
{
  "data": {
    "import_templates": {
      "all": {
        "edges": [
          {
            "node": {
              "id": "45",
              "file_regexp": "^ORDERS_.*\\.csv$",
              "template_type": "StandardOrder",
              "account": {
                "id": "3",
                "code": "ACME"
              },
              "ftp_user": {
                "id": "12",
                "name": "Acme Inbound Feed"
              },
              "mapping_group": {
                "id": "45"
              }
            }
          }
        ]
      }
    }
  }
}

​
Query Structure

query($filter: ImportTemplateFilterType) {
  import_templates {
    all(filter: $filter) {
      edges {
        node {
          id
          file_regexp
          template_type
          account { id code }
          ftp_user { id name }
          mapping_group { 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": {
    "template_type": {
      "eq": "value"
    }
  }
}

​
Available Filters

FilterInput TypeOperatorsDescription
template_typeImportTemplatesTemplateTypeInputTypeeq, inTemplate type (enum input — e.g. StandardOrder)
file_regexpStringInputTypeeq, ilike, like, in, betweenFilename-matching regexp
account_idIdInputTypeeq, in, gt, gteq, lt, lteq, filledStock account ID
account_codeStringInputTypeeq, ilike, like, in, betweenStock account code
ftp_user_idIdInputTypeeq, in, gt, gteq, lt, lteq, filledSFTP user ID
ftp_user_nameStringInputTypeeq, ilike, like, in, betweenSFTP user name
mapping_group_idIdInputTypeeq, in, gt, gteq, lt, lteq, filledMapping group ID
created_atDatetimeInputTypeeq, from, to, betweenCreation timestamp
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: ImportTemplateFilterType) { import_templates { all(filter: $filter) { edges { node { id file_regexp template_type account { id code } ftp_user { id name } mapping_group { id } } } } } }"

​
variables
object

Query variables including the filter object

Example:
{
  "filter": {
    "template_type": { "eq": "StandardOrder" }
  }
}

Response

Successful GraphQL response

​
data
object

Query result data

​
errors
object[]

GraphQL errors, if any