API ReferenceLists

Get a custom list

Authentication

X-API-Keystring

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

Path parameters

list_idstringRequired

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:

Response

List details.
created_atdatetime
idstring
is_activeboolean
item_countinteger
list_typestring
match_modestring
namestring
descriptionstring or null
org_idstring
updated_atdatetime
used_by_workflowslist of objects

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error