Skip to main content
GET
List address books

Authorizations

Authorization
string
header
required

Beem API credentials: API key as username, API secret as password.

Query Parameters

page
integer

Page number for pagination (default: 1).

Required range: x >= 1
limit
integer

Number of items per page (default: 10).

Required range: x >= 1
q
string

Search query to filter address books by name (case-insensitive, partial match).

parent_ven_id
string

Filter by parent vendor ID (reseller accounts).

start_date
string

Filter address books created on or after this date.

end_date
string

Filter address books created on or before this date.

Response

List of address books with pagination metadata.

data
object[]
pagination
object