apiClients

Query the project's API clients (OAuth credentials).

Use it in a workflow

Add a step and choose the Commercetools connector.
Pick the apiClients action (under Api).
Fill in the fields below, then reference the result from later steps as {{apiclients.response.data}}.

Query

This is the query the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

query ApiClients($where: String, $sort: [String!], $limit: Int, $offset: Int) {
  apiClients(where: $where, sort: $sort, limit: $limit, offset: $offset) {
    offset
    count
    total
    exists
    results {
      id
      name
      scope
      createdAt
      lastUsedAt
      deleteAt
      accessTokenValiditySeconds
      refreshTokenValiditySeconds
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

wherestring

sortarray<string>

limitnumber

offsetnumber

json

{
  "where": "string",
  "sort": [
    "string"
  ],
  "limit": 0,
  "offset": 0
}

Response

Read the result with {{apiclients.response.data.data.apiClients}}. If the API returns errors, the step fails and they are at {{apiclients.response.data.errors}}.

offsetnumber

countnumber

totalstring

existsboolean

resultsarray<object>

idobject

nameobject

scopeobject

createdAtobject

lastUsedAtobject

deleteAtobject

accessTokenValiditySecondsobject

refreshTokenValiditySecondsobject

Need more? See the Commercetools guide for connection setup and behaviour shared by every action.

Was this page helpful?