APIReferenceTeam payouts
get Team Profitability
get Team Profitability. 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.
Authorization
BearerAuth AuthorizationBearer <token>
Personal Access Token. Mint at Settings → API. Token shape: hsk_<env>_<prefix12>_<secret32>.
In: header
Query Parameters
from?string
to?string
userId?string
projectId?string
clientId?string
view?string
page?integer
perPage?integer
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/team-payouts/profitability"{ "data": { "from": "2019-08-24", "to": "2019-08-24", "view": "work", "baseCurrency": "string", "page": 0, "perPage": 0, "memberTotal": 0, "summary": { "userId": "string", "payeeId": "79417842-2e1e-4110-a361-89b9f39b36ed", "name": "string", "projectId": "string", "projectName": "string", "billedNet": "string", "collectedNet": "string", "compensationCost": "string", "approvedCost": "string", "estimatedCost": "string", "paid": "string", "pending": "string", "clientUnbilledSeconds": 0, "margin": "string", "marginPercent": "string", "missingFx": true, "missingPayRate": true, "missingMetrics": [ "billedNet" ], "nativeAmounts": [ { "currency": "string", "metric": "billedNet", "amount": "string" } ], "links": { "app": "string", "payee": "string", "project": "string", "task": "string" } }, "members": [ { "userId": "string", "payeeId": "79417842-2e1e-4110-a361-89b9f39b36ed", "name": "string", "projectId": "string", "projectName": "string", "billedNet": "string", "collectedNet": "string", "compensationCost": "string", "approvedCost": "string", "estimatedCost": "string", "paid": "string", "pending": "string", "clientUnbilledSeconds": 0, "margin": "string", "marginPercent": "string", "missingFx": true, "missingPayRate": true, "missingMetrics": [ "billedNet" ], "nativeAmounts": [ { "currency": "string", "metric": "billedNet", "amount": "string" } ], "links": { "app": "string", "payee": "string", "project": "string", "task": "string" }, "projectCount": 0, "projects": [ { "userId": "string", "payeeId": "79417842-2e1e-4110-a361-89b9f39b36ed", "name": "string", "projectId": "string", "projectName": "string", "billedNet": "string", "collectedNet": "string", "compensationCost": "string", "approvedCost": "string", "estimatedCost": "string", "paid": "string", "pending": "string", "clientUnbilledSeconds": 0, "margin": "string", "marginPercent": "string", "missingFx": true, "missingPayRate": true, "missingMetrics": [ "billedNet" ], "nativeAmounts": [ { "currency": "string", "metric": "billedNet", "amount": "string" } ], "links": { "app": "string", "payee": "string", "project": "string", "task": "string" } } ] } ], "missingRateCount": 0, "unallocatedRevenue": [ { "currency": "string", "amount": "string" } ], "unreconciledReceipts": [ { "currency": "string", "amount": "string" } ], "missingFx": [ { "fromCurrency": "string", "toCurrency": "string", "amount": "string", "metric": "billedNet" } ], "fxRates": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "fromCurrency": "string", "toCurrency": "string", "effectiveFrom": "2019-08-24", "createdAt": "2019-08-24T14:15:22Z", "used": true, "rate": "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?
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.
Hoursmith MCP server
Connect Claude, Cursor, Zed, Odin, and other AI tools to your Hoursmith workspace with the official Model Context Protocol server.