API documentation | API docs for agents | OpenAPI 3.1

GET /api/v1/reports/commissions

ark.get_commission_report

Returns permissioned commission detail rows, user summaries, or both.

Availability

Expanded preview

Scopes

reports:read

ARK permissions

canViewReportscanViewCommissionReport

Team visibility

Required and enforced

Idempotency-Key

Not required

Approval

No MCP approval on REST API-token calls

Rate limit

API credential and organization budgets

Parameters

fromquerystringrequired

toquerystringrequired

team_idsquerystring

Comma-separated visible team IDs. Omit to use every team available to the credential.

viewquerystring

one of: detail, summary, both; default: "both"

pagequeryinteger

min: 1

page_sizequeryinteger

min: 1; max: 500

user_idquerystring

customer_idquerystring

is_paidqueryboolean

date_filter_typequerystring

one of: delivery_date, created_date, booking_date, pickup_date; default: "delivery_date"

paid_date_filter_typequerystring

one of: delivery_date, paid_date; default: "delivery_date"

customer_currencyquerystring

one of: USD, CAD, MXN

detail_sort_columnquerystring

summary_sort_columnquerystring

sort_directionquerystring

one of: asc, desc; default: "desc"

Request body

None.

Example request

curl 'https://arktms.com/api/v1/reports/commissions?from=<from>&to=<to>' \
  -H "Authorization: Bearer $ARK_API_TOKEN"

Success response

Report result

Errors

HTTP 400

Invalid request

HTTP 401

Authentication required

HTTP 403

Permission, scope, team, or entitlement denied