Skip to main content
GET
List contacts

Authorizations

Authorization
string
header
required

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

Query Parameters

addressbook_id
string
required

Address book ID to list contacts from.

limit
integer

Maximum contacts to return per page.

page
integer

Page number (starts at 1).

q
string

Search term to filter contacts by name or number.

tags
string

Filter contacts by tag name.

Response

List of contacts with pagination metadata.

data
object[]
pagination
object

Pagination metadata.