Skip to main content
GET
List contacts

Authorizations

Authorization
string
header
required

An API key created in BeanRails, for example brk_live_....

Query Parameters

limit
integer
default:10

Records per page. Defaults to 10, capped at 100.

Required range: 1 <= x <= 100
page
integer
default:1

Page number, starting at 1.

Required range: x >= 1

Free-text search across the record's main fields, such as its number, name or email.

lifecycle_stage
enum<string>

Filter by lifecycle stage.

Available options:
lead,
customer
status
string

Filter by contact status value.

user_id
integer

Filter by assigned user ID.

Response

A page of contacts.

data
object[]
meta
object