Common Schemas
Standard error response format
Properties
Section titled “Properties”| Property | Type | Description |
|---|---|---|
error |
string |
Human-readable error message |
Example
Section titled “Example”{ "error": "Invalid request: IP address not whitelisted."}Phone number. Recommended format is E.164
with a leading + and country code (e.g., +14155551234).
Parseable values are normalized server-side to E.164 via libphonenumber. Other formats (bare 10-digit, with parentheses/dashes/spaces, etc.) are accepted as submitted, but may be rejected downstream by carriers or supplier APIs (Blacklane, Bokun, TourCMS, etc.) if they can’t parse the value.
Only missing or empty values return a 400 error from this API.
Examples:
- US E.164:
+14155551234(normalized) - UK E.164:
+442071234567(normalized) - US with formatting:
+1 (415) 555-1234(normalized to+14155551234) - Bare 10-digit US:
4155551234(passed through verbatim; not normalized)
Example
Section titled “Example”"+14155551234"Pagination
Section titled “Pagination”Pagination metadata for list responses
Properties
Section titled “Properties”| Property | Type | Description |
|---|---|---|
limit |
integer |
Maximum number of results per page |
offset |
integer |
Number of results skipped |
total |
integer |
Total number of results available |