Skip to content
Hoursmith Docs
APIReferenceTeam payouts

get Team Payment

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.

GET
/team-payouts/payments/{id}

Authorization

BearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

id*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/payments/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "payeeId": "79417842-2e1e-4110-a361-89b9f39b36ed",    "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",    "currency": "string",    "amount": "string",    "paidDate": "2019-08-24",    "method": "string",    "savedMethodId": "string",    "reference": "string",    "note": "string",    "createdAt": "2019-08-24T14:15:22Z",    "status": "RECORDED",    "reversedAt": "2019-08-24T14:15:22Z",    "reversalReason": "string",    "settlementCurrency": "string",    "settlementAmount": "string",    "exchangeRate": "string",    "settlementMode": "string",    "allocations": [      {        "billId": "b9de0a53-2363-44cf-9760-a7ddf29fedb4",        "number": "string",        "currency": "string",        "amount": "string",        "cashAmount": "string",        "cashCurrency": "string",        "links": {          "app": "string",          "payee": "string",          "project": "string",          "task": "string"        }      }    ],    "links": {      "app": "string",      "payee": "string",      "project": "string",      "task": "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 Bill

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.

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.