Skip to content
You are offline. Some features may be unavailable.
EsperWorksEsperWorks

Contracts

Read contracts and proposals created in EsperWorks. Contract creation and signing is managed through the EsperWorks dashboard; the API provides read access for integration purposes.

Endpoints

GEThttps://api.tryesperworks.com/api/v1/contractscontracts:read

List contracts. Supports ?type=, ?status=, ?per_page=.

GEThttps://api.tryesperworks.com/api/v1/contracts/:idcontracts:read

Get a single contract with client details.

List contracts

curl "https://api.tryesperworks.com/api/v1/contracts?status=signed&per_page=10" \
  -H "Authorization: Bearer ew_live_xxxx"

Response

{
  "contract": {
    "id": 7,
    "title": "Website Redesign Agreement",
    "type": "contract",
    "status": "signed",
    "currency": "GHS",
    "client": { "id": 42, "name": "Kofi Mensah", "email": "kofi@example.com" },
    "business_signed_at": "2026-04-20T09:00:00Z",
    "client_signed_at": "2026-04-21T14:32:00Z",
    "created_at": "2026-04-19T08:00:00Z"
  }
}

Contract types

TypeDescription
contractA standard service or work agreement.
proposalA proposal sent to a prospective client.

Contract statuses

StatusDescription
draftNot yet sent to the client.
sentSent to the client for review.
acceptedClient has accepted (proposals).
signedBoth parties have signed.
declinedClient declined.
expiredSigning token expired before client signed.