Skip to main content
GET
List company contacts

Authorizations

Authorization
string
header
required

Bearer token authentication

Query Parameters

page
integer

Page number for pagination

Required range: x >= 1
Example:

1

per_page
integer

Number of records per page

Required range: x >= 1
Example:

10

status
string

Filter contacts by status

Example:

"active"

search_query
string

Search contacts by name, email, or phone

Example:

"john"

by_metadata
string

Filter contacts by metadata (JSON string)

Example:

"{\"source\": \"api\"}"

Response

object | null

Success

contacts
Contact · object · null · null[] | null
meta
object | null