Skip to main content
Every successful Verbeo response follows the same envelope. This page is the canonical reference — individual endpoint pages document the resource-specific data payload but link here for the wrapper format.

​
Success envelope

​
boolean
required
Always true on success. See Errors for the failure shape.
​
object | array
required
The resource the endpoint returns. Object for single-resource reads/writes (e.g. GET /campaigns/{id}), array for list endpoints (e.g. GET /campaigns).

​
Status codes

​
List responses and pagination

List endpoints (e.g. GET /campaigns) return their items in data plus a pagination object describing the slice you received.
​
number
Total number of resources matching the query, across all pages.
​
number
required
Number of items in the current response.
​
string | null
required
Cursor to fetch the next page. null when there is no further page.
How you pass the cursor back depends on the resource:
  • Campaigns list with a GET. Pass the cursor as the offset query parameter:
  • Assistants, phone numbers and tools list with a POST whose body carries page and size. The cursor is the next page number: pass it as page.

​
Conventions

  • Identifiers are UUID v4 strings unless stated otherwise.
  • Timestamps are ISO 8601 in UTC, e.g. "2026-05-04T15:00:00.000Z".
  • Phone numbers are E.164 strings, e.g. "+12125550001".
  • Money values are decimal strings to avoid float rounding. (Reserved — no current endpoint returns money.)

​
Backwards-compatibility policy

The API follows an additive compatibility policy: new fields may appear in data payloads without notice. Existing fields will not be removed or renamed without an advance deprecation announcement. Branch on error.code for error handling, not on error.message — see Errors.