Skip to main content
GET
List contacts

Authorizations

Authorization
string
header
required

An API key from Settings > API keys (lsk_...), which acts on its own business, or a platform key from the PLATFORM_API_KEYS setting (lsp_...), which onboards and manages businesses. Scopes: business:read, business:write, calls:read, contacts:read, contacts:write, appointments:read, appointments:write, messages:read, knowledge:read, knowledge:write, webhooks:manage, billing:manage, phone_numbers:manage, team:manage, businesses:create, users:create, phone_numbers:purchase, partner:read, partner.businesses:write, partner.demos:write, partner.packages:write, partner.branding:write, partner.templates:write, partner.team:write, partner.billing:read, partner.billing:write. Only platform keys can hold businesses:create and users:create, and only a key a partner made in its console can hold the partner scopes, which the Partner endpoints use. Only a partner's owners grant partner.billing:read and partner.billing:write.

Headers

LobbyStack-Business
string<uuid>

The business a platform key acts on. Required with a platform key. A per-business key may leave it out; if it sends one, it must be the key's own business.

Query Parameters

limit
integer

Items per page, 1 to 100. Defaults to 25.

Required range: 1 <= x <= 100
cursor
string

The next_cursor value from the previous page.

phone
string

Only the contact with this E.164 phone number.

email
string

Only contacts with this email address.

name
string

Only contacts whose name contains this text. Case does not matter.

Maximum string length: 200

Response

OK

data
object[]
required
next_cursor
string | null
required

Pass as cursor to get the next page. Null on the last page.

has_more
boolean
required