Skip to main content
POST
Contact

Headers

Accept
string

e.g. application/json

x-api-key
string

e.g. [Required] Partner specific API key provided by Birdeye for data exchange.

Query Parameters

businessId
string
required

Id of the Business.

page
number
required

The page number.

size
number
required

Maximum number of contacts return in response.

sortby
string
required

The sorting order of the list.

Body

application/json
startDate
string

Start Date in format mm/dd/yyyy

endDate
string

End Date in format mm/dd/yyyy

Response

OK

page
number

The page number.

size
number

Maximum number of contacts return in response.

totalPages
number

Number of pages to query.

totalCount
number

Number of contacts to query.

customers
any[]

Customer list