POST /resources/v1/ticket/{businessNumber}/get/all?
Servers
- https://api.birdeye.com/resources
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
businessNumber |
Number | Yes |
Business number of the account. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
api_key |
String | No |
e.g. abcdefgh (string, required) - Partner specific API key provided by Birdeye for data exchange. |
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 |
|---|---|---|---|
sIndex |
Number | Yes |
Start index of the response. Default value - 0 |
sortOrder |
Number | Yes |
Sort Order [0] will sort the data in ascending order. [1] this will sort the data in descending order. Default value - 1 |
count |
Number | Yes |
Number of tickets want to get in the response. Default value - 25 |
sortBy |
Number | Yes |
Sort options, Possible values [2] will sort on the basis of ticket creation date. [3] will sort on the basis of characters of business aliases. Default value 2. |
op |
Number | Yes |
Possible values are: [1] will display ticket count only, [3] will display all the data of the ticket. Default value - 3. |
totalCount |
String | Yes |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
toDate |
Number | No |
Epoc end date. |
tagNames[] |
Array | No |
Tag assigned to any review ticket. |
assignees[] |
Array | No |
List of assignee email id. |
fromDate |
Number | No |
Epoc start date. |
ticketStatuses[] |
Array | No |
Filter tickets with status. |
ticketTypes[] |
Array | No |
List of ticket type, Possible values |
sourceAliases[] |
Array | No |
Source alias. |
sourceTypes[] |
Array | No |
Source Type. |
businessNumbers[] |
Array | No |
List of Location Business Numbers. |
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.