Documentation
API Reference

List Agreementsget

Create Agreementpost

Get Agreementget

Void Agreementpatch

Resend Agreement Emailpatch

Reassign Agreementpatch

Download Agreement PDFget

Generate Shareable Linkget

Agreement History

Get Agreement Historyget

List Agreement Historyget

List Templatesget

Get Templateget

Agreement Types

List Agreement Typesget

Agreement Statuses

List Agreement Statusesget

Upload Attachmentpost

Other endpoints

powered by Zuplo

API Documentation

API Documentation

Agreement Statuses

Endpointhttps://api.commonpaper.com

View possible agreement status values

List Agreement Statuses

GET

https://api.commonpaper.com

/v1/agreement_statuses

This endpoint returns a list of all possible agreement statuses within Common Paper. Agreement statuses indicate the current state of an agreement.

List Agreement Statuses › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

List Agreement Statuses › Responses

OK

GET/v1/agreement_statuses

curl --request GET \
  --url https://api.commonpaper.com/v1/agreement_statuses \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "data": [
    "sent_waiting_for_initial_review",
    "sent_waiting_for_sender_review",
    "sent_waiting_for_recipient_review",
    "sent_to_recipient_for_signature",
    "sent_to_sender_signer_for_signature",
    "sent_to_hellosign_by_recipient_initial_review",
    "sent_to_hellosign_by_recipient",
    "sent_to_hellosign_by_sender",
    "waiting_for_sender_signature",
    "waiting_for_recipient_signature",
    "declined_by_recipient",
    "signed_waiting_for_final_confirmation",
    "signed",
    "draft",
    "voided_by_sender"
  ]
}

json

application/json

Agreement Types Attachments