Retrieve Agreements
Get a paginated list of all agreements created by your account via the API.
Send request
- GET https://api.zigned.io/rest/v2/agreements
- Content-type: application/json
Query Parameters
limitInteger
Limits the results up to the specified amount.
- Is required? No
- Default value: 50
pageInteger
Specifies which page to retrieve
- Is required? No
- Default value: 1
start_dateDateTime
Get a paginated list of all agreements created by your account via the API.
- Is required? No
- Default value: -
end_dateDateTime
Specifies which max date to retrieve agreements from.
- Is required? No
- Default value: -
Code example
const fetch = require('node-fetch');
let url = 'https://api.zigned.io/rest/v2/agreements?limit=20&page=2&start_date=2021-12-01&end_date=2021-12-31';
let options = {method: 'GET', headers: {'x-zigned-api-key': 'Your API key'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error('error:' + err));
Success response
Description
Details
- HTTP Status: 200
- Mime type: application/json
Response body
agreementsArray
Array of Agreement Objects
paginationObject
Object with pagination data
Code Example
{
"agreements": [{
"id": "bc08cbbd-d565-4d07-b219-71cb607a2216",
"status": "draft",
"test_mode": false,
"issuer": "John Doe",
"sign_intents": [{
"id": "4da3a490-db93-476b-ba24-f548e79f75ae",
"email": "email@example.com",
"status": "draft",
"signing_room_url": "www.zigned.se",
"signing_session": {
"id": "6b4a86ae-5f58-4836-828f-9e23cee2dba7",
"status": "draft",
"signing_session_events": [{
"id": "be39518a-4b76-48f5-bc0a-b9c3738f4379",
"title": "Entered Signing Room",
"description": "Entered Signing Room",
"ip": "80.217.101.28",
"user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/96.0.4664.110 Safari/537.36",
"created_at": "Tue, 11 Jan 2022 15:59:53 GMT"
}],
"signed_at": "Tue, 11 Jan 2022 15:59:53 GMT",
"signature_method": "Signature not initiated",
"created_at": "Tue, 11 Jan 2022 15:59:53 GMT",
"updated_at": "Tue, 11 Jan 2022 15:59:53 GMT"
},
"created_at": "Tue, 11 Jan 2022 15:59:53 GMT",
"updated_at": "Tue, 11 Jan 2022 15:59:53 GMT"
}],
"original_document": {
"id": "7c7cfbc0-32c5-4a2b-8cd0-4e39585f9f03",
"filename": "example.pdf",
"mime_type": "application/pdf",
"url": "www.zigned.se",
"compatibility_check": "successful",
"created_at": "Tue, 11 Jan 2022 15:59:53 GMT",
"updated_at": "Tue, 11 Jan 2022 15:59:53 GMT"
},
"signed_document": {
"id": "7c7cfbc0-32c5-4a2b-8cd0-4e39585f9f03",
"filename": "example.pdf",
"mime_type": "application/pdf",
"url": "www.zigned.se",
"compatibility_check": "successful",
"created_at": "Tue, 11 Jan 2022 15:59:53 GMT",
"updated_at": "Tue, 11 Jan 2022 15:59:53 GMT"
},
"created_at": "Tue, 11 Jan 2022 15:59:53 GMT",
"updated_at": "Tue, 11 Jan 2022 15:59:53 GMT"
}],
"pagination": {
"limit": 50,
"total_pages": 2,
"page": 1
}
}