POST /v2/customer/list
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 |
|---|---|---|---|
page |
Number | Yes |
The page number. |
api_key |
String | Yes |
Partner specific API key provided by Birdeye for data exchange. |
businessId |
String | Yes |
Id of the Business. |
size |
Number | Yes |
Maximum number of contacts return in response. |
sortby |
String | Yes |
The sorting order of the list. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
endDate |
String | No |
End Date in format mm/dd/yyyy |
startDate |
String | No |
Start Date in format mm/dd/yyyy |
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.