apiClient

A single API client (OAuth credentials + scopes) by ID.

Use it in a workflow

Query

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

query ApiClient($id: String!) {
  apiClient(id: $id) {
    id
    name
    scope
    createdAt
    lastUsedAt
    deleteAt
    accessTokenValiditySeconds
    refreshTokenValiditySeconds
  }
}

Variables

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

{
  "id": "string"
}

Response

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

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