Get ticket

API Method: GET /api/tickets

Description:

This endpoint is used to retrieve detailed information about a specific support or service ticket within the banking application, based on the provided ticket ID. It allows authorized users to access the current status, history, and other relevant details of a ticket, such as customer requests, issue progress, and resolution steps. This can be used by customer service representatives, administrators, or users tracking their own tickets.

Request:

  • HTTP Method: GET
  • Endpoint: /api/tickets
  • Authentication: Requires authentication (e.g., Bearer token or session ID) to ensure that only authorized users can access ticket information.

Query Parameters:

  • ticketId (string, required): The unique identifier of the ticket being queried.
Example Query:
/api/tickets?ticketId=123456

Request Headers:

  • Authorization: Bearer <token> (required) — The token used to authenticate the request.

Response:

  • Status Code: 200 OK — On success, the API returns detailed information about the specified ticket.
  • Content-Type: application/json

Possible Errors:

  • 400 Bad Request: The request is missing the required ticketId parameter or the parameter is invalid.
  • 401 Unauthorized: The request was made without proper authentication or with an invalid token.
  • 403 Forbidden: The user does not have permission to view the ticket.
  • 404 Not Found: No ticket was found with the specified ticketId.
  • 500 Internal Server Error: An error occurred on the server while processing the request.

Example Usage:

curl -X GET /api/tickets?ticketId=123456 \
-H "Authorization: Bearer <token>"

This request retrieves the details of a specific ticket, including its status, assigned agent, and any comments or updates, based on the provided ticketId.

Language
Credentials
Bearer
JWT
Click Try It! to start a request and see the response here!