Skip to Content

API reference / Get started

Responses and pagination

Read response envelopes and fetch additional pages without guessing.

Successful REST responses wrap the result in data. A paginated result puts its pagination fields beside that array:

{
  "data": [],
  "total": 0,
  "page": 1,
  "pageSize": 50,
  "pageCount": 0
}

This is an illustrative empty page. Non-paginated lists can simply return a data array. Do not assume all list operations accept the same pagination parameters.

Page through contacts

GET /contacts accepts a 1-based page and a pageSize of 50, 200, 500, or 1000. The default size is 50. Keep the same filters as you request subsequent pages.

curl --fail-with-body \
  'https://app.vendita.io/api/v1/contacts?page=1&pageSize=50' \
  -H "Authorization: Bearer $VENDITA_API_KEY"

Increment page while it is less than the returned pageCount. Contact results can change while your integration runs, so use contact IDs to recognise records already processed.

For filtering, use the parameters documented on the specific endpoint. Invalid enum values or malformed pagination parameters return a validation error.

Request IDs

Authenticated REST responses carry x-request-id. Preserve it with the method, path, time, status, and error when diagnosing a request. Failures before authentication completes may not include it.

On this page