- Overview
- How it works?
- Getting Started
- Developer reference
- Zoho Writer
- Zoho PDF Editor
- Zoho Sheet
- Zoho Show
- GETPlan details
- Errors
- Manage Office Integrator
- Pricing
- How-to Guides
Document Sessions
Purpose
To get the list of active sessions for a particular PDF.
HTTP Request URL
https://{api.office-integrator_domain}/pdfeditor/officeapi/v1/pdf/<document_id>/sessions?apikey=<apikey>
Request Parameters
| Parameter | Data Type | Description |
| Mandatory Parameters | ||
| apikey | String | Uniquely identifies the web application in which the PDF editor is integrated. |
| document_id | String | Unique id of the document. |
Sample Request
Copiedhttps://api.office-integrator.com/pdfeditor/officeapi/v1/pdf/1349/sessions?apikey=423s*****Sample Response
Copied{
"document_name": "New.pdf",
"created_time": "2025-05-14T05:10:13Z",
"sessions": [
{
"user_info": {
"user_id": "3001",
"display_name": "Rose"
},
"status": "active",
"info": {
"created_time": "2025-05-14T05:25:48Z",
"created_time_ms": "1747200348600",
"expires_on_ms": "1747221013368",
"session_delete_url": "https://api.office-integrator.com/pdfeditor/officeapi/v1/sessions/f8bcb3d10050ee0a3a6dc138873e5d17a686a3c4fbaf37b7a60328a608ca04d45a5e88b4d472354b2010e106034a2ed3f3f5cd36462782a3592db159cec833e30e3335e02d9c628e64d5e65a4bd3a3e6c50a5afbee4dbcb057bc6563049eab37",
"expires_on": "2025-05-14T11:10:13Z",
"session_url": "https://api.office-integrator.com/pdfeditor/officeapi/v1/documents/f8bcb3d10050ee0a3a6dc138873e5d17a686a3c4fbaf37b7a60328a608ca04d45a5e88b4d472354b2010e106034a2ed3f3f5cd36462782a3592db159cec833e30e3335e02d9c628e64d5e65a4bd3a3e6c50a5afbee4dbcb057bc6563049eab37/edit",
"document_id": "1234"
}
},
{
"user_info": {
"user_id": "3002",
"display_name": "John"
},
"status": "inactive",
"info": {
"created_time": "2025-05-14T05:10:17Z",
"created_time_ms": "1747199417394",
"expires_on_ms": "1747221013368",
"session_delete_url": "https://api.office-integrator.com/pdfeditor/officeapi/v1/sessions/eb8b6390708636d36530945e2adbbc09b6465a9a29a071706296f93853e785caf2724067be00317005d18bbeefaece1871d3d769dce201483ffc99030df655e6467e1b837bbed8853e35c37e0a1375f7fdb293194d0cbbe0caf86d4580b034ec",
"expires_on": "2025-05-14T11:10:13Z",
"session_url": "https://api.office-integrator.com/pdfeditor/officeapi/v1/pdf/eb8b6390708636d36530945e2adbbc09b6465a9a29a071706296f93853e785caf2724067be00317005d18bbeefaece1871d3d769dce201483ffc99030df655e6467e1b837bbed8853e35c37e0a1375f7fdb293194d0cbbe0caf86d4580b034ec/edit",
"document_id": "1234"
}
},
{
"user_info": {
"user_id": "3003",
"display_name": "Amelia"
},
"status": "inactive",
"info": {
"created_time": "2025-05-14T05:12:06Z",
"created_time_ms": "1747199526829",
"expires_on_ms": "1747221013368",
"session_delete_url": "https://api.office-integrator.com/pdfeditor/officeapi/v1/sessions/62d011a1293a9f9d7c9b96ff829e45ae93217670c03458d56953eef4354ad435cdd47cb2c565eb457c601eb7e786c3917497aefd611965bdc68b83ccf812886106259db91a405c8e956457a1336b98ca24327b7276ac0640d3cd0e3f04e82f55",
"expires_on": "2025-05-14T11:10:13Z",
"session_url": "https://api.office-integrator.com/pdfeditor/officeapi/v1/pdf/62d011a1293a9f9d7c9b96ff829e45ae93217670c03458d56953eef4354ad435cdd47cb2c565eb457c601eb7e786c3917497aefd611965bdc68b83ccf812886106259db91a405c8e956457a1336b98ca24327b7276ac0640d3cd0e3f04e82f55/edit",
"document_id": "1234"
}
}
],
"collaborators_count": "3",
"active_sessions_count": "1",
"created_time_ms": "1747199413368",
"expires_on_ms": "1747221013368",
"expires_on": "2025-05-14T11:10:13Z",
"type": "native",
"document_id": "1234"
}Show full
Show less
© 2025, Zoho Corporation Pvt. Ltd. All Rights Reserved.