Pagination

Every list endpoint returns a page of results plus the metadata to walk the rest.

Query parameters

Note the casing: these are PascalCase, unlike the JSON bodies elsewhere in the API.

Parameter	Default	Notes
`PageNumber`	`1`	The first page is 1, not 0.
`PageSize`	`10`	Items per page.
`Search`		Free-text filter. What it matches depends on the endpoint — for contacts it covers id, name, email and description.

Some endpoints add their own filters, such as IsFavorite on contacts and vaults.

Invalid values fall back silently. A PageSize that is empty, negative or not a number does not produce a 400 — it is replaced by the default. If a page comes back a different size than you asked for, check the spelling and the casing before anything else.

Ordering is fixed. Results come back newest first and there is no sort parameter you can act on. Because the ordering key is a timestamp with no tiebreaker, rows created in the same instant can swap places between requests — for large collections, expect the occasional duplicate or gap when paging, and deduplicate on id.

Response

{
  "items": [ ... ],
  "pagination": {
    "totalItems": 128,
    "pageSize": 50,
    "pageNumber": 2,
    "pageItems": 50
  }
}

Field	Meaning
`totalItems`	Total matching the query, across all pages.
`pageSize`	Items requested per page.
`pageNumber`	The page you are on.
`pageItems`	Items actually returned on this page.

Walking every page

Stop when pageItems comes back smaller than pageSize.

Keep an eye on the rate limit when paging through large collections: a large PageSize costs one request where many small pages cost many.

Listing envelopes

There is no "list envelopes" endpoint. Enumeration goes through the vault:

GET /v1/ecm/vaults/{vaultId}/list

which returns envelopes and templates together, each item carrying a type discriminator, with excludeEnvelopes and excludeTemplates to narrow it. Trashed envelopes never appear.

Query parameters#

Response#

Walking every page#

Listing envelopes#

Query parameters

Response

Walking every page

Listing envelopes