myBranches

Requires a customer (portal or buyer app) session.

the caller's assigned ACTIVE branch addresses — drives the FE branch picker.

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 MyBranches {
  myBranches {
    id
    approverCount
    isActive
    isBranch
    label
    memberCount
    approvers {
      firstName
      lastName
      email
      role
      userId
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query MyBranches {\n  myBranches {\n    id\n    approverCount\n    isActive\n    isBranch\n    label\n    memberCount\n    approvers {\n      firstName\n      lastName\n      email\n      role\n      userId\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "myBranches": [
      {
        "id": "id",
        "approverCount": 0,
        "isActive": true,
        "isBranch": true,
        "label": "string",
        "memberCount": 0,
        "approvers": [
          {
            "firstName": "string",
            "lastName": "string",
            "email": "string",
            "role": "string",
            "userId": "id"
          }
        ]
      }
    ]
  }
}

myBranches: [CustomerBranch!]!

Type

CustomerBranch object

a partner sales branch — an Address with isBranch = true. The label is the branch name; pendingApprovalCount feeds the deactivation warning (EDGE #4).