Skip to content
Hoursmith Docs
APIReferenceTeam payouts

get Team Payout Summary

get Team Payout Summary. Read-only. Owner/Admin tokens with read scope only. Agency plan required. Generic member endpoints never expose compensation. Dates are ISO calendar transport values; money is a decimal string. Links require an authenticated Owner/Admin app session. Unknown and repeated query parameters return 422.

GET
/team-payouts/summary

Authorization

BearerAuth
AuthorizationBearer <token>

Personal Access Token. Mint at Settings → API. Token shape: hsk_<env>_<prefix12>_<secret32>.

In: header

Query Parameters

payeeId?string
currency?string

Supported currency. Bills use bill currency; payments use actual transfer currency.

clientId?string
projectId?string
from?string
to?string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/team-payouts/summary"
{  "data": {    "canManage": true,    "currencies": [      {        "currency": "string",        "eligibleSeconds": 0,        "unbilledFrom": "2019-08-24",        "unbilledTo": "2019-08-24",        "accrued": "string",        "approved": "string",        "paid": "string",        "outstanding": "string",        "overdue": "string",        "credit": "string"      }    ],    "missingRateCount": 0,    "eligibleSeconds": 0,    "memberCount": 0,    "lastPaymentDate": "2019-08-24",    "lastPaymentAmount": "string",    "lastPaymentCurrency": "string"  }}
{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string",    "requestId": "string"  }}
{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string",    "requestId": "string"  }}
{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string",    "requestId": "string"  }}
{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string",    "requestId": "string"  }}
{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string",    "requestId": "string"  }}
{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string",    "requestId": "string"  }}
Was this page helpful?

get Team Payment

Read-only. Owner/Admin tokens with read scope only. Studio+ retains finalized bills and recorded payment history after Agency downgrade; drafts require Agency. Generic member endpoints never expose compensation. Dates are ISO calendar transport values; money is a decimal string. Links require an authenticated Owner/Admin app session. Unknown and repeated query parameters return 422.

list Team Unpaid Time

Read-only. Owner/Admin tokens with read scope only. Agency plan required. Generic member endpoints never expose compensation. Dates are ISO calendar transport values; money is a decimal string. Links require an authenticated Owner/Admin app session. Unknown and repeated query parameters return 422.