For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Getting Started
Use Cases
Core Concepts
Integration Guides
API Details
Tutorials
Best Practices
- Changelog
API Reference

API Reference Lists

List items in a custom list

GET

https://devapi.withverifa.com/api/v1/lists/:list_id/items

GET

/api/v1/lists/:list_id/items

$ curl https://devapi.withverifa.com/api/v1/lists/list_id/items \
>      -H "X-API-Key: <apiKey>"

1 {
2   "data": [
3     {
4       "id": "string",
5       "value": {},
6       "created_at": "2024-01-15T09:30:00Z",
7       "list_id": "string",
8       "match_count": 1,
9       "last_matched_at": "2024-01-15T09:30:00Z",
10       "notes": "string",
11       "is_active": true,
12       "updated_at": "2024-01-15T09:30:00Z"
13     }
14   ],
15   "pagination": {
16     "total": 1,
17     "limit": 1,
18     "offset": 1
19   }
20 }

Was this page helpful?

Add an item to 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:

Query parameters

qstringOptional

Search by value text.

limitintegerOptional1-200Defaults to 50

offsetintegerOptional>=0Defaults to 0

Response

Paginated list items.

datalist of objects

paginationobject

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error