API Reference

Get all documents

get
https://ext.edusign.fr/v2/documents

Alt Text Retrieve all the documents of your school (with and without signature). The "TYPE" field define if the retrieved document is without signature ("TYPE" = 1) or with signature ("TYPE" = 2).
WARNING This is an heavy request, please use this endpoint only when needed.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
Defaults to false

Retrieve or not the HTML version of the document. WARNING : The weight of the HTML template can have an impact on the payload size and request speed, depending on the quantity of documents to retrieve.

string
Defaults to 0

Query param for pagination, starts at page "0" and displays "limit" documents per page, with a maximum of 500.

string
Defaults to 500

Query param for pagination, maximum of 500 documents per page.

string

Retrieve documents based on a recipient resource ID :

  • Student ID
  • Professor ID
  • External ID
  • Admin ID (a user with the 'admin' rights in Edusign)
string

Retrieve documents based on its signature state :

  • "completed" : All recipients have signed the document
  • "pending" : At least one signature is still pending
  • "expired" : The signature link is no longer available
  • "refused" : The recipient(s) have refused to sign
string

Retrieve documents created after the provided date (format YYYY-MM-DDThh:mm:ss, ISO 8601)

string

Retrieve documents created before the provided date (format YYYY-MM-DDThh:mm:ss, ISO 8601)

Response

Updated 12 days ago

What’s Next
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 12 days ago

What’s Next