Get document status

GET/api/v1/getDocumentStatus

curl 'https://app.quote.cloud/api/v1/getDocumentStatus?client_id=<your client id>&document_id=<document_id>' \
  -H 'Authorization: Bearer <your token>'

<your token> and <your client id> are placeholders. Get your own

Inputs

client_idrequiredYou don’t need to enter this here. In your own code, use the Client ID from your OAuth client. How to get one

document_idrequiredThe document’s number, shown as #1234 in the ID column of your documents list and beside the title in the editor. Enter it without the #. You can also use the id from an API response.

Not sure what to enter? Here’s where to find IDs

Example response

{
  "data": {
    "id": "string",
    "documentId": "string",
    "displayId": 0,
    "documentName": "string",
    "documentTitle": "string",
    "status": "sent",
    "outcome": {
      "type": "lost",
      "reason": "string",
      "reasonDetails": "string",
      "recordedAt": "2026-01-31T09:30:00Z"
    },
    "createdDate": "2026-01-31T09:30:00Z",
    "statusChangedAt": "2026-01-31T09:30:00Z",
    "modifiedDate": "2026-01-31T09:30:00Z"
  }
}

The spec has no example, so this 200 response is generated from the schema. Values are placeholders.

Get a document's current status

Permission

An OAuth access token with this scope. How to get a token

documents:read_status

Read document status.

Parameters

Not sure what to enter? Here’s where to find IDs.

client_idquery · stringrequired

The Client ID of your OAuth client. It’s public, and goes on every request alongside your access token. Find it in QuoteCloud under Settings → API dashboard → Manage Integrations → OAuth Clients.Length at least 1.

document_idquery · stringrequired

The document’s number, shown as #1234 in the ID column of your documents list and beside the title in the editor. Enter it without the #. You can also use the id from an API response.

Responses

200Document status.

dataobjectrequired

Fields

idstringrequired

documentIdstringrequired

displayIdinteger or nullrequired

documentNamestringrequired

documentTitlestringrequired

statusstringrequired

One of sent, opened, signing, signing_complete, part_paid, paid, accepted, lost, canceled, creating, revising, workflow_review_requested, workflow_review_accepted, pending_sent, scheduled_send, delivery_delayed, delivered, alert, email_complained, email_bounced, send_failed, expired, custom, template, system_template.

outcomeobject or nullrequired

Fields

typestringrequired

One of lost, canceled.

reasonstring or nullrequired

reasonDetailsstring or nullrequired

recordedAtstring (date-time) or nullrequired

createdDatestring (date-time)required

statusChangedAtstring (date-time)

modifiedDatestring (date-time)required

401Missing or invalid bearer token or client ID.

errorstringrequired

error_descriptionstring

403Insufficient scope, missing add-on, usage limit, or permission denial.

Exactly one of these:

OAuthError

errorstringrequired

error_descriptionstring

ApiErrorEnvelope

dataobjectrequired

Fields

statusstringrequired

Always error.

messagestringrequired

codestring

documentRefstring

assetGenerationIdstring

errorsarray of object

Item fields

fieldstringrequired

messagestringrequired

404Requested resource was not found in the token's company.

dataobjectrequired

Fields

statusstringrequired

Always error.

messagestringrequired

codestring

documentRefstring

assetGenerationIdstring

errorsarray of object

Item fields

fieldstringrequired

messagestringrequired

Rate limit

120 requests a minute per company, shared across REST, Zapier and MCP. On a 429, wait for Retry-After.