partnerCustomerUser

Requires permission customers:customer_user:read.

Returns one person who can sign in for a 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 PartnerCustomerUser($partnerId: ID!, $userId: ID!) {
  partnerCustomerUser(partnerId: $partnerId, userId: $userId) {
    id
    firstName
    lastName
    status
    createdAt
    approverScope
    addresses {
      id
      type
      isActive
      isApprover
      isAssigned
      isBranch
    }
  }
}

cURL

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

Variables:

{
  "partnerId": "id",
  "userId": "id"
}

Response:

{
  "data": {
    "partnerCustomerUser": {
      "id": "id",
      "firstName": "string",
      "lastName": "string",
      "status": "string",
      "createdAt": "2025-01-15T00:00:00Z",
      "approverScope": "string",
      "addresses": [
        {
          "id": "id",
          "type": "string",
          "isActive": true,
          "isApprover": true,
          "isAssigned": true,
          "isBranch": true
        }
      ]
    }
  }
}

partnerCustomerUser(
  partnerId: ID!
  userId: ID!
): PartnerCustomerUserDetail!

Arguments

partnerCustomerUser.partnerId ● ID! non-null scalar

The ID of the customer company.

partnerCustomerUser.userId ● ID! non-null scalar

The ID of the customer user.

Type

PartnerCustomerUserDetail object

Everything the account owner assigned to one buyer login, in one payload.