Skip to main content
POST
/
graphql#ListMappingGroups
List mapping groups
curl --request POST \
  --url 'https://clarus-api.com/graphql#ListMappingGroups' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "query": "query($filter: MappingGroupFilterType) { mapping_groups { all(filter: $filter) { edges { node { id name description operation_type integration { id } mapping_group_fields { id field_name field_type } } } } } }"
}
'
{
  "data": {
    "mapping_groups": {
      "all": {
        "edges": [
          {
            "node": {
              "id": "88",
              "name": "Shopify products",
              "description": "Maps Shopify products to Clarus products",
              "operation_type": "integration_product",
              "integration": {
                "id": "12"
              },
              "mapping_group_fields": [
                {
                  "id": "210",
                  "field_name": "sku",
                  "field_type": "string"
                }
              ]
            }
          }
        ]
      }
    }
  }
}

​
Query Structure

query($filter: MappingGroupFilterType) {
  mapping_groups {
    all(filter: $filter) {
      edges {
        node {
          id
          name
          description
          operation_type
          integration { id }
          mapping_group_fields { id field_name field_type }
        }
      }
    }
  }
}

​
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": {
    "name": {
      "ilike": "value"
    }
  }
}

​
Available Filters

FilterInput TypeOperatorsDescription
nameStringInputTypeeq, ilike, like, in, betweenGroup name
descriptionStringInputTypeeq, ilike, like, in, betweenGroup description
operation_typeOperationTypeInputTypeeq, inOperation type (enum input)
integration_idIdInputTypeeq, in, gt, gteq, lt, lteq, filledOwning integration 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: MappingGroupFilterType) { mapping_groups { all(filter: $filter) { edges { node { id name description operation_type integration { id } mapping_group_fields { id field_name field_type } } } } } }"

​
variables
object

Query variables including the filter object

Example:
{
  "filter": {
    "operation_type": { "eq": "integration_product" }
  }
}

Response

Successful GraphQL response

​
data
object

Query result data

​
errors
object[]

GraphQL errors, if any