customerGroup

QUERY

customerGroup(customerGroupId: ID!): CustomerGroup

Arguments

customerGroupId

ID!

required

Returns

CustomerGroup

ID!

name

String!

key

String!

A unique, human-readable identifier for the group (e.g. 'enterprise') used when referencing the group in API calls and integrations.

color

String!

externalId

String

An optional identifier from your own system, used to reference this group when calling upsertCustomerGroup without knowing the Plain-assigned ID.

createdAt

createdBy

updatedAt

updatedBy

Query

query CustomerGroup($customerGroupId: ID!) {
  customerGroup(customerGroupId: $customerGroupId) {
    id
    name
    key
    color
    externalId
    createdAt {
      unixTimestamp
      iso8601
    }
  }
}

Variables

{
  "customerGroupId": "id"
}

Response

{
  "data": {
    "customerGroup": {
      "id": "id",
      "name": "string",
      "key": "string",
      "color": "string",
      "externalId": "string",
      "createdAt": {
        "unixTimestamp": "string",
        "iso8601": "string"
      }
    }
  }
}

⌘I

Query

query CustomerGroup($customerGroupId: ID!) {
  customerGroup(customerGroupId: $customerGroupId) {
    id
    name
    key
    color
    externalId
    createdAt {
      unixTimestamp
      iso8601
    }
  }
}

Variables

{
  "customerGroupId": "id"
}

Response

{
  "data": {
    "customerGroup": {
      "id": "id",
      "name": "string",
      "key": "string",
      "color": "string",
      "externalId": "string",
      "createdAt": {
        "unixTimestamp": "string",
        "iso8601": "string"
      }
    }
  }
}

Queries

Mutations

Types

Arguments

Returns