Paperform API

Getting Started
Forms
Form Fields
Submissions
Partial Submissions
Products
Coupons
Webhooks
Spaces
Translations
Papersign Documents
Papersign Folders
- /papersign/foldersget
- /papersign/folderspost
Papersign Webhooks
Papersign Spaces
- /papersign/spacesget

Paperform API

Getting Started
Forms
Form Fields
Submissions
Partial Submissions
Products
Coupons
Webhooks
Spaces
Translations
Papersign Documents
Papersign Folders
- /papersign/foldersget
- /papersign/folderspost
Papersign Webhooks
Papersign Spaces
- /papersign/spacesget

/papersign/documents

get https://api.paperform.co/v1/papersign/documents

This endpoint returns a list of documents.
Please note that this feature is exclusively available as part of the Papersign API.

URL Expired

The URL for this request expired after 30 days.

Query Params

string

Search documents by name.

folder_id

string

Search folders that are descendants of folder id.

status

array of strings

Search documents by status.

status

limit

integer

≤ 100

Defaults to 20

The number or results to return.

skip

integer

Defaults to 0

Number of results to skip in the result set.

after_id

string

Return results after the provided ID.

before_id

string

Return results before the provided ID.

before_date

date-time

Return results created on or after this date-time (UTC). Overwritten by before_id.

after_date

date-time

Return results created before this date (UTC). Overwritten by after_id.

sort

string

Defaults to DESC

The direction to sort in. Results are sorted by created_at, and defaults to "DESC".

Responses

Response body

object

status

string

ok

results

object

documents

array of objects

documents

object

string

The unique identifier of the document.

name

string

The name of the document.

status

string

The status of the document.

draft archived in_progress canceled completed expired rejected

folder

object

space

object

signers

array of objects

signers

object

key

string

required

The key for the signer.

name

string

required

The name of the signer.

string

required

The signer's email address.

phone

string | null

The signer's phone number.

job_title

string | null

The signer's job title.

company

string | null

The signer's company.

custom_attributes

array of objects

Custom attributes for the signer.

custom_attributes

object

key

string

label

string | null

value

string | null

variables

array of objects

variables

object

key

string

required

The key for the variable. Must be unique for the document.

name

string

The name of the signer.

value

string

The value of the variable.

created_at_utc

date-time

A formatted date-time string in UTC indicating the time the document was created.

updated_at_utc

date-time

A formatted date-time string in UTC indicating the time the document was last updated.

sent_at_utc

date-time

A formatted date-time string in UTC indicating the time the document was sent.

completed_at_utc

date-time

A formatted date-time string in UTC indicating the time the document was completed.

total

integer

The total number of items.

has_more

boolean

Whether there are more items.

limit

integer

Defaults to 20

The limit of items per page.

skip

integer

Defaults to 0

The number of items to skip.

Response body

object

status

string

error

message

string

An error message.

details

array of strings

Suggested actions to resolve the error.

details

error_type

string

Invalid parameters provided.

validation

Response body

object

status

string

error

message

string

An error message.

details

array of strings

Suggested actions to resolve the error.

details

error_type

string

Token not provided for not valid.

authentication

Response body

object

status

string

error

message

string

An error message.

details

array of strings

Suggested actions to resolve the error.

details

error_type

string

Not permitted to access requested resource.

permission

Response body

object

status

string

error

message

string

An error message.

details

array of strings

Suggested actions to resolve the error.

details

error_type

string

The requested resource was not found.

not_found

Response body

object

status

string

error

message

string

An error message.

details

array of strings

Suggested actions to resolve the error.

details

error_type

string

Invalid parameters provided.

validation

Response body

string

Response body

object

status

string

error

message

string

An error message.

details

array of strings

Suggested actions to resolve the error.

details

error_type

string

An unexpected error.

server_error

Updated 9 months ago

/translations/{id}

/papersign/documents/{id}

Did this page help you?

Language

Credentials

Bearer


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.paperform.co/v1/papersign/documents?limit=20&skip=0&sort=DESC' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/html

Updated 9 months ago

/translations/{id}

/papersign/documents/{id}

Did this page help you?

Paperform API
Getting Started
Forms
/forms/{slug_or_id}put
/forms/{slug_or_id}get
/formsget
Form Fields
/forms/{slug_or_id}/fields/{field_key}put
/forms/{slug_or_id}/fields/{field_key}get
/forms/{slug_or_id}/fieldsget
Submissions
/submissions/{id}delete
/submissions/{id}get
/forms/{slug_or_id}/submissions/{id}delete
/forms/{slug_or_id}/submissions/{id}get
/forms/{slug_or_id}/submissionsget
Partial Submissions
/partial-submissions/{id}delete
/partial-submissions/{id}get
/forms/{slug_or_id}/partial-submissions/{id}delete
/forms/{slug_or_id}/partial-submissions/{id}get
/forms/{slug_or_id}/partial-submissionsget
Products
/forms/{slug_or_id}/products/{product_sku}/soldput
/forms/{slug_or_id}/products/{product_sku}/quantityput
/forms/{slug_or_id}/products/{product_sku}delete
/forms/{slug_or_id}/products/{product_sku}put
/forms/{slug_or_id}/products/{product_sku}get
/forms/{slug_or_id}/productspost
/forms/{slug_or_id}/productsget
Coupons
/forms/{slug_or_id}/coupons/{code}delete
/forms/{slug_or_id}/coupons/{code}put
/forms/{slug_or_id}/coupons/{code}get
/forms/{slug_or_id}/couponspost
/forms/{slug_or_id}/couponsget
Webhooks
/webhooks/{id}delete
/webhooks/{id}put
/webhooks/{id}get
/forms/{slug_or_id}/webhookspost
/forms/{slug_or_id}/webhooksget
Spaces
/spaces/{id}/formsget
/spaces/{id}put
/spaces/{id}get
/spacespost
/spacesget
Translations
/translations/{id}delete
/translations/{id}put
/translations/{id}get
/translationspost
/translationsget
Papersign Documents
/papersign/documents/{id}/movepost
/papersign/documents/{id}/cancelput
/papersign/documents/{id}/copypost
/papersign/documents/{id}/sendpost
/papersign/documents/{id}get
/papersign/documentsget
Papersign Folders
/papersign/folderspost
/papersign/foldersget
Papersign Webhooks
/papersign/webhooks/{id}delete
/papersign/webhooks/{id}put
/papersign/folders/{id}/webhookspost
/papersign/folders/{id}/webhooksget
Papersign Spaces
/papersign/spacesget

Paperform API
Getting Started
Forms
/forms/{slug_or_id}put
/forms/{slug_or_id}get
/formsget
Form Fields
/forms/{slug_or_id}/fields/{field_key}put
/forms/{slug_or_id}/fields/{field_key}get
/forms/{slug_or_id}/fieldsget
Submissions
/submissions/{id}delete
/submissions/{id}get
/forms/{slug_or_id}/submissions/{id}delete
/forms/{slug_or_id}/submissions/{id}get
/forms/{slug_or_id}/submissionsget
Partial Submissions
/partial-submissions/{id}delete
/partial-submissions/{id}get
/forms/{slug_or_id}/partial-submissions/{id}delete
/forms/{slug_or_id}/partial-submissions/{id}get
/forms/{slug_or_id}/partial-submissionsget
Products
/forms/{slug_or_id}/products/{product_sku}/soldput
/forms/{slug_or_id}/products/{product_sku}/quantityput
/forms/{slug_or_id}/products/{product_sku}delete
/forms/{slug_or_id}/products/{product_sku}put
/forms/{slug_or_id}/products/{product_sku}get
/forms/{slug_or_id}/productspost
/forms/{slug_or_id}/productsget
Coupons
/forms/{slug_or_id}/coupons/{code}delete
/forms/{slug_or_id}/coupons/{code}put
/forms/{slug_or_id}/coupons/{code}get
/forms/{slug_or_id}/couponspost
/forms/{slug_or_id}/couponsget
Webhooks
/webhooks/{id}delete
/webhooks/{id}put
/webhooks/{id}get
/forms/{slug_or_id}/webhookspost
/forms/{slug_or_id}/webhooksget
Spaces
/spaces/{id}/formsget
/spaces/{id}put
/spaces/{id}get
/spacespost
/spacesget
Translations
/translations/{id}delete
/translations/{id}put
/translations/{id}get
/translationspost
/translationsget
Papersign Documents
/papersign/documents/{id}/movepost
/papersign/documents/{id}/cancelput
/papersign/documents/{id}/copypost
/papersign/documents/{id}/sendpost
/papersign/documents/{id}get
/papersign/documentsget
Papersign Folders
/papersign/folderspost
/papersign/foldersget
Papersign Webhooks
/papersign/webhooks/{id}delete
/papersign/webhooks/{id}put
/papersign/folders/{id}/webhookspost
/papersign/folders/{id}/webhooksget
Papersign Spaces
/papersign/spacesget

200Successfully returned a list of documents

400Invalid Request

401Unauthorized

403Not Permitted

404Not Found

422Validation Error

429Too Many Requests

5XXUnexpected Error