Skip to content
Hoursmith Docs
APIReferenceTeam payouts

List fixed-pay agreements

List fixed-pay agreements. Read-only. Fixed-pay agreements (oldest start first, up to 500), optionally for one payee, with status relative to today. Unknown or repeated query parameters return 422. Owner/Admin only (Managers and Members receive 403 before any record lookup); Agency plan (`teamPayouts`, 402 with requiredPlan agency otherwise). Requires the `read` scope. Money values are exact decimal strings; dates are ISO calendar dates.

GET
/team-payouts/fixed-agreements

Authorization

BearerAuth
AuthorizationBearer <token>

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

In: header

Query Parameters

payeeId?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/fixed-agreements"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "payeeId": "79417842-2e1e-4110-a361-89b9f39b36ed",      "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",      "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",      "projectName": "string",      "cadence": "PROJECT",      "description": "string",      "amount": "string",      "currency": "string",      "startsOn": "2019-08-24",      "endsOn": "2019-08-24",      "archivedAt": "2019-08-24T14:15:22Z",      "archivedOn": "2019-08-24",      "status": "ACTIVE",      "links": {        "app": "string",        "payee": "string"      }    }  ],  "warnings": [    "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?