Skip to main content
POST
Customer or Lead list

Headers

Accept
string
default:application/json

e.g. application/json

x-api-key
string

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

Content-Type
string
default:application/json

Media type of the JSON request body.

Query Parameters

tags
boolean

If tag data is required send true, default value is false.

customfields
boolean

If custom fields data is required send true, default is false.

Body

application/json
startDateUtc
string
required

Start date in format mm/dd/yyyy.

endDateUtc
string
required

End date in format mm/dd/yyyy.

businessId
number
required

Business number of the location, when enterprise number is provided, then fetch data for all locations.

page
string
required

Page number to request.

size
string
required

Number of records per page, max is 5000.

sources
any[]

Source of the customer/lead. Possible values are api,dashboard,facebook,integration,sftp,bulkupload,webchat,crmimport,other,referral,voicecall,text,email,google.

contactType
string

Possible values are "lead", "customer". If blank then all contact types are returned.

Response

OK

page
number

Page number to request.

size
number

Number of records per page.

totalPages
number

Total number of pages.

contacts
object[]

Contact details