API Reference
Addresses
API reference for managing saved addresses.
List Addresses
GET /v1/addresses
Query Parameters
| Param | Type | Description |
|---|---|---|
limit | number | Max results (1-100, default 25) |
starting_after | string | Cursor for forward pagination |
search | string | Search by company name, city, or ZIP |
Create Address
POST /v1/addresses
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
company | string | Yes | Company name |
contact | string | No | Contact name |
street | string | No | Street address |
city | string | Yes | City |
state | string | Yes | 2-letter state code |
zip | string | Yes | ZIP code |
phone | string | No | Phone number |
email | string | No | Email address |
Retrieve Address
GET /v1/addresses/:id
Update Address
PATCH /v1/addresses/:id
Delete Address
DELETE /v1/addresses/:id