List proposals

Read-only. Pass external_system + external_id together to look up a single proposal by an external ID instead of listing.

GET /v1/proposals

Bearer token

curl 'https://api.sendapropos.com/v1/proposals?limit=1&cursor=example&status=draft&external_system=example&external_id=external_01JXY9AZK4KV' \
  --request GET \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "data": [
    {
      "id": "123e4567-e89b-42d3-a456-426614174000",
      "proposalNumber": 1,
      "name": "example",
      "customerId": "123e4567-e89b-42d3-a456-426614174000",
      "status": "draft",
      "clientName": "example",
      "clientEmail": "[email protected]",
      "createdAt": "2026-01-01T12:00:00Z"
    }
  ],
  "nextCursor": "example"
}

A page of proposals.

Query parameters

· 5

limit integer · min: 1· max: 100

Page size, 1-100. Defaults to 25.

cursor string

Opaque pagination cursor from a previous response's nextCursor.

status ProposalStatus · enum

expired is computed at read time against the proposal's expiry date, not a status ever written to the database. There is no viewed value on the wire — it's tracked internally as an activity log entry, not a status.

values

draft
sent
accepted
partially_signed
signed
expired

external_system string

Name of the external system owning external_id (e.g. zapier, quickbase). Must be paired with external_id.

external_id string

The record ID from the external system. Must be paired with external_system.

Query parameters

Responses