POST /v1/contact/details
Servers
- https://api.birdeye.com/resources
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Accept |
String | No |
e.g. application/json |
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
api_key |
String | Yes |
Partner specific API key provided by Birdeye for data exchange. |
tags |
Boolean | No |
If tag data is required send true, default value is false. |
customfields |
Boolean | No |
If custom fields data is required send true, default is false. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
page |
String | Yes |
Page number to request. |
sources[] |
Array | No |
Source of the customer/lead. Possible values are api,dashboard,facebook,integration,sftp,bulkupload,webchat,crmimport,other,referral,voicecall,text,email,google. |
businessId |
Number | Yes |
Business number of the location, when enterprise number is provided, then fetch data for all locations. |
size |
String | Yes |
Number of records per page, max is 5000. |
endDateUtc |
String | Yes |
End date in format mm/dd/yyyy. |
startDateUtc |
String | Yes |
Start date in format mm/dd/yyyy. |
contactType |
String | No |
Possible values are "lead", "customer". If blank then all contact types are returned. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.