partnerCustomerUsers

Requires permission customers:customer_user:read.

Lists the people who can sign in to the buyer apps and portal for one customer company. Needs customers:customer_user:read.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query PartnerCustomerUsers($partnerId: ID!) {
  partnerCustomerUsers(partnerId: $partnerId) {
    id
    firstName
    lastName
    status
    createdAt
    approverScope
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query PartnerCustomerUsers($partnerId: ID!) {\n  partnerCustomerUsers(partnerId: $partnerId) {\n    id\n    firstName\n    lastName\n    status\n    createdAt\n    approverScope\n  }\n}",
  "variables": {
    "partnerId": "id"
  }
}
EOF

Variables:

{
  "partnerId": "id"
}

Response:

{
  "data": {
    "partnerCustomerUsers": [
      {
        "id": "id",
        "firstName": "string",
        "lastName": "string",
        "status": "string",
        "createdAt": "2025-01-15T00:00:00Z",
        "approverScope": "string"
      }
    ]
  }
}

partnerCustomerUsers(
  partnerId: ID!
): [PartnerCustomerUser!]!

Arguments

partnerCustomerUsers.partnerId ● ID! non-null scalar

The ID of the customer company.

Type

PartnerCustomerUser object

One row of a customer's Users tab on the partner record: a buyer login.