API ReferenceSessions

List sessions

Returns a paginated list of sessions for your organization.

Authentication

X-API-Keystring

Organization API key. Keys are prefixed with vk_live_ (production) or vk_sandbox_ (sandbox).

Headers

Verifa-VersiondateOptional

API version date string (e.g. 2026-02-01). If omitted, the version pinned to your API key is used.

Key-InflectionenumOptionalDefaults to snake

Response key casing. Defaults to snake.

Allowed values:

Query parameters

statusenumOptional
Filter by session status.
qstringOptional
Search by session ID or external reference.
limitintegerOptional1-100Defaults to 50
Maximum number of sessions to return.
offsetintegerOptional>=0Defaults to 0
Number of sessions to skip.

Response

A list of sessions.
datalist of objects
paginationobject

Errors

401
Unauthorized Error
429
Too Many Requests Error