GET /v2/accounts/{account_id}/tickets
Description:
This API request returns the tickets of an account up for the past year.
API Limit:
600 requests per minute. Client receives 429 once over the limit.
Method Details:
Http method: GET
Response format: Json
Headers:
useriq-api-key: Your valid API key generated from the site settings page
Content-Type: application/json
Parameters:
Path Parameter:
-
{account_id}: required, the account ID for the account for which you want to pull tickets
Response:
Status code 200:
The body contains the result, which is a list of tickets for the requested account_id.
Other Status code:
400: Bad request
401: Unauthorized.
429: Too many requests.
Response field description:
-
ticket_id: (String), the id of the ticket.
-
subject: (String), the subject of the ticket.
-
status: (String), the status of the ticket.
-
ticket_type: (String), the type of the ticket.
-
priority: (String), the priority of the ticket.
-
recipient: (String) the recipient.
-
solved_time_minutes: (Integer) the elapsed times before the ticket is solved in minutes
-
from_email: (String) the email of the ticket creator.
-
from_name: (String) the name of the ticket creator.
-
ticket_url: (String), the link to the ticket.
-
solved_at: UTC, format yyyy-MM-dd hh:mm:ss.SSS, the time the ticket is resolved.
-
created_at: UTC, format yyyy-MM-dd hh:mm:ss.SSS, the time the ticket is created,
-
updated_at: UTC, format yyyy-MM-dd hh:mm:ss.SSS, the last time the ticket is updated
-
source: (String), the source of the ticket origination, e.g., Zendesk, SFDC, API. The ticket created with create ticket api has the {"source":"API"}.
Example GET Request:
1. Example Request:
GET https://api.useriq.com/v2/accounts/1234/tickets
Example Response
{
"success": true,
"result": [
{
"site_id": 123456,
"account_id": "1234",
"status": "hold",
"ticket_id": "8488d499-fbf6-4e50-8d80-ad8ff3a763dd",
"ticket_type": "problem",
"subject": "login problem",
"priority": "normal",
"from_email": "alexf@mail.com",
"from_name": "Alex Fro",
"source": "Zendesk",
"created_at": "2021-02-16 06:11:49.483",
"updated_at": "2021-02-16 06:11:49.483",
"solved_at": "2021-02-16 04:11:49.483"
},
{
"site_id": 123456,
"account_id": "1234",
"status": "solved",
"ticket_id": "aa74f80a-a382-4357-86cf-472d3e32e6e4",
"ticket_type": "problem",
"subject": "work flows",
"priority": "normal",
"from_email": "ander@yahoo.com",
"from_name": "Frost Anderson",
"source": "API",
"created_at": "2021-02-16 06:11:49.798",
"updated_at": "2021-02-16 06:11:49.798",
"solved_at": "2021-02-16 05:11:49.483"
},
...
]
}
Comments
0 comments
Please sign in to leave a comment.