Skip to main content

Session Details

Purpose 

To get the details of a particular PDF session.

HTTP Request URL

https://{api.office-integrator_domain}/pdfeditor/officeapi/v1/sessions/<session_id>?apikey=<apikey>

Request Parameters

ParameterValueDescription
Mandatory Parameters
apikeyStringUniquely identifies the web application in which the PDF editor is integrated.
session_idStringUnique user session id of the document.

Sample Request

Copiedhttps://api.office-integrator.com/pdfeditor/officeapi/v1/sessions/d26aa7b8029b5rf8d34c7dd00139392357d12ffcb21c1?apikey=423s*****

Sample Response

Copied{
    "user_info": {
        "user_id": "3001",
        "display_name": "Rose"
    },
    "status": "active",
    "info": {
        "created_time": "2025-03-21T12:55:04Z",
        "created_time_ms": 1742561704066,
        "expires_on_ms": 1742583300047,
        "session_delete_url": "https://api.office-integrator.com/pdfeditor/officeapi/v1/sessions/533e80dcb22b9e5ecfbd051e1015fc81012d62e73a985a95e3d74b9109abcda47333653538970dd6d02d0c248afdaf1850bab02e00b98e20ca7194a230137168db7bb4187e722154352f0e8e33b3d191460889af842f1bea8755d5f5b0c58664",
        "expires_on": "2025-03-21T18:55:00Z",
        "session_url": "https://api.office-integrator.com/pdfeditor/officeapi/v1/pdf/533e80dcb22b9e5ecfbd051e1015fc81012d62e73a985a95e3d74b9109abcda47333653538970dd6d02d0c248afdaf1850bab02e00b98e20ca7194a230137168db7bb4187e722154352f0e8e33b3d191460889af842f1bea8755d5f5b0c58664/edit",
        "document_id": "a07ed266-b33f-4cc3-8c03-eaf697bb3226"
    }
}