API documentation | API docs for agents | OpenAPI 3.1

commission-settings

ark.get_user_commission_settings

Returns default role commission settings and customer-specific commission overrides for an organization user. Requires tenant-admin access and admin:read.

Availability: Expanded preview
Scopes: admin:read
ARK permissions: None
Team visibility: Not entity-scoped
Idempotency-Key: Not required
Approval: No MCP approval on REST API-token calls
Rate limit: API credential and organization budgets

Parameters

userIdpathstringrequired: format: uuid

Request body

None.

Example request

Shell

curl 'https://arktms.com/api/v1/users/<userId>/commission-settings' \
  -H "Authorization: Bearer $ARK_API_TOKEN"

Success response

User commission settings

objectstringrequired

one of: api_response

okbooleanrequired

one of: true

api_versionstringrequired

one of: 2026-05-31

request_idstringrequired

dataobjectrequired

data.userobjectrequired

data.roleCommissionsarray<object>required

data.overridesarray<object>required

Errors

HTTP 400: Invalid request
HTTP 401: Authentication required
HTTP 403: Permission, scope, team, or entitlement denied
HTTP 404: Resource not found