commissionHierarchy

Requires permission commissions:commission:read.

Lists the organization structure for the commission setup: one row per active staff user, with their role, level, rate and who they report to. Requires permission to read commissions.

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 CommissionHierarchy {
  commissionHierarchy {
    reportsToName
    userName
    level
    rate
    rateActive
    reportsToUserId
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query CommissionHierarchy {\n  commissionHierarchy {\n    reportsToName\n    userName\n    level\n    rate\n    rateActive\n    reportsToUserId\n  }\n}"
}
EOF

Response:

{
  "data": {
    "commissionHierarchy": [
      {
        "reportsToName": "string",
        "userName": "string",
        "level": 0,
        "rate": 0,
        "rateActive": true,
        "reportsToUserId": "string"
      }
    ]
  }
}

commissionHierarchy: [CommissionHierarchyRow!]!

Type

CommissionHierarchyRow object

One row of the hierarchical commission setup: a staff user, their manager, their level, and the rate set for their role.