repCommissionProfiles

Requires permission commissions:commission:read.

Lists each sales rep's commission profile and default rate, for the caller's scope. 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 RepCommissionProfiles {
  repCommissionProfiles {
    id
    repName
    defaultRate
    isActive
    repEmail
    userId
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query RepCommissionProfiles {\n  repCommissionProfiles {\n    id\n    repName\n    defaultRate\n    isActive\n    repEmail\n    userId\n  }\n}"
}
EOF

Response:

{
  "data": {
    "repCommissionProfiles": [
      {
        "id": "id",
        "repName": "string",
        "defaultRate": 0,
        "isActive": true,
        "repEmail": "string",
        "userId": "string"
      }
    ]
  }
}

repCommissionProfiles: [RepCommissionProfile!]!

Type

RepCommissionProfile object

A rep's commission setup.