Skip to content
Embed API
/
API Reference
/
/
Retrieve details of exist...

Retrieve details of existing browser session

Request

Returns details of the existing browser session. This information can serve as the source of truth when the user is redirected to your success handler.

Security
APIKey
Path
session_idstring, (uuid)required

The UUID of the session to retrieve.

Example:7f3f5f62-2c69-7d4e-8a3d-9c0f0e2c5f3a
Headers
Acceptstringrequired

Specify the response format.

Value:"application/json"
curl -i -X GET \
  https://api.builder.docue.com/api/browser/sessions/7f3f5f62-2c69-7d4e-8a3d-9c0f0e2c5f3a \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer <YOUR_API Key_HERE>'

Responses

Successfully retrieved the session.

Bodyapplication/json
dataobject(Api.BrowserSession.Data.BrowserSessionData.BrowserSessionData)
Response
{
  "data": {
    "id": "7f3f5f62-2c69-7d4e-8a3d-9c0f0e2c5f3a",
    "status": "completed",
    "state": { … }
  }
}