List proposals

GET/v1/proposals/envelopes

Authorization

bearerAuth

AuthorizationBearer <token>

API token issued from the dashboard (Settings → API Tokens). Sent as Authorization: Bearer <token>.

In: header

Query Parameters

status?string

Lifecycle state of the envelope.

type?string

A document is sent to recipients; a template is instantiated into documents.

Default"document"

Value in"document" | "template"

limit?integer

Max results to return. 1-200. Default 50.

Default50

Range0 < value <= 200

Response Body

`application/json`

cURL

curl -X GET "https://example.com/proposals/envelopes"

{
  "envelopes": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "secondaryId": "P-1042",
      "externalId": "string",
      "title": "Acme Corp — Q2 Engagement",
      "status": "draft",
      "type": "document",
      "totalAmount": "5000.00",
      "currency": "USD",
      "sentAt": "2019-08-24T14:15:22Z",
      "completedAt": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z"
    }
  ]
}

{
  "error": "validation_failed",
  "message": "string",
  "issues": null
}

{
  "error": "unauthorized"
}

Authorization

Query Parameters

Response Body

200application/json

400application/json

401application/json

`application/json`

`application/json`

`application/json`