DEVELOPER DOCUMENTATION
List Contracts
List contracts on jobs linked by this install, newest first. Filter by project link or status.
GET
/api/partner/v1/contractsReturns contracts whose job is referenced by at least one project link on the calling token’s install, newest first. This is the pull-side complement to the contract.started / contract.ended webhooks — poll it to reconcile state after downtime, since events are never replayed.
Requirements: contracts:read scope.
Request
Section titled “Request”projectLinkIdstringqueryRestrict to contracts on the job linked by this project link. Returns 404 if no link with this ID exists on the install.
statusstringqueryFilter by contract status: active or ended.
limitintegerqueryDefault:
50Maximum number of contracts to return (1–200).
Response
Section titled “Response”contractsobject[]Array of contracts, newest first.
Errors
Section titled “Errors”| Status | code | Meaning |
|---|---|---|
400 | BAD_REQUEST | Invalid status value or limit out of range |
401 | UNAUTHORIZED | Missing, invalid, or revoked token |
403 | FORBIDDEN | Token lacks contracts:read |
404 | NOT_FOUND | projectLinkId does not match a link on this install |