/api/v1/tickets/getTicketById

Time	Status	User Agent
Retrieving recent requests…

Time

Status

User Agent

Retrieving recent requests…

Get Ticket by ID

Fetches the complete detail record for a single ticket, including its current status, priority, department, description, assignment, resolution notes, and timestamps. Use this endpoint to check the current state of a ticket after creation or to display ticket details in a merchant management interface.

Endpoint

GET /api/v1/tickets/getTicketById

Authentication

Basic HTTP Authentication required.
Encode username:password in Base64 and pass in the Authorization header:

Authorization: Basic {base64(username:password)}

When to use

Use this endpoint to monitor the lifecycle of an open ticket — for example, to check whether an Instant Funding request has moved from New to InProgress or Resolved. It is also used to verify ticket details before performing update operations or to confirm that a newly created ticket was captured correctly.

Query Parameters

Parameter	Type	Required	Description
`id`	integer (int32)	Yes	Merchant profile ID associated with the ticket.
`ticketId`	integer (int32)	Yes	ID of the ticket to retrieve.

Response

200 OK

Field	Type	Description
`data.ticketId`	integer	The unique ticket ID.
`data.status`	string	Current ticket status: `New`, `Pending`, `InProgress`, or `Resolved`.
`data.merchantProfileId`	integer	Merchant profile ID linked to the ticket.
`data.dba`	string	Merchant DBA name.
`data.subject`	string	Ticket subject line.
`data.priority`	string	Ticket priority: `Low`, `Medium`, `High`, or `Critical`.
`data.department`	string	Assigned department: `CustomerService` or `Underwriting`.
`data.description`	string	Full description of the ticket request.
`data.category`	string	Ticket category (if assigned by the department).
`data.subCategory`	string	Ticket sub-category (if assigned).
`data.assigned`	string	Name or username of the assigned agent.
`data.resolution`	string	Resolution notes entered when the ticket is closed.
`data.type`	string	Ticket type classification.
`data.created`	string (date-time)	ISO 8601 timestamp when the ticket was created.
`data.updated`	string (date-time)	ISO 8601 timestamp of the last update.
`data.hasAttachment`	boolean	`true` if one or more attachments exist on the ticket.
`data.creationType`	string	Indicates how the ticket was created (e.g., `API`, `Portal`).
`requestId`	integer	Internal request tracking ID.
`success`	boolean	`true` if the ticket was retrieved successfully.
`error`	string	Error message if the operation failed.
`validationErrors`	array	List of field-level validation issues.

{
  "data": {
    "ticketId": 48291,
    "status": "InProgress",
    "merchantProfileId": 70269,
    "dba": "Sunshine Retail LLC",
    "subject": "Instant Funding",
    "priority": "Low",
    "department": "Underwriting",
    "description": "Please enable Instant Funding for this merchant. Banking application has been submitted.",
    "category": "Funding",
    "subCategory": "Instant Funding",
    "assigned": "[email protected]",
    "resolution": null,
    "type": "Request",
    "created": "2026-05-15T09:00:00Z",
    "updated": "2026-05-20T14:32:00Z",
    "hasAttachment": true,
    "creationType": "API"
  },
  "requestId": 98130,
  "success": true,
  "error": null,
  "validationErrors": []
}

Error Codes

Code	When it happens
400	Missing or invalid query parameters (`id` or `ticketId`).
401	Invalid or missing Basic Auth credentials.
403	User does not have permission for this operation.
404	Ticket not found for the given `ticketId`.
500	Internal server error.

Common Mistakes

Confusing the id (merchant profile ID) with the ticketId — both are required and distinct.
Assuming the status field will immediately reflect changes — allow a short delay after update operations before polling.
Checking hasAttachment and expecting a list — use getAttachmentsByTicketId to retrieve the attachment list.

Related Endpoints

GET /api/v1/tickets/getTickets — List multiple tickets with filtering options.
POST /api/v1/tickets/update — Update the status or details of this ticket.
GET /api/v1/tickets/getCommentsByTicketId — Retrieve the comment thread for this ticket.

Example

curl -X GET "https://hq.staging.netevia.dev/api/v1/tickets/getTicketById?id=70269&ticketId=48291" \
  -H "Authorization: Basic $(echo -n 'username:password' | base64)"