Get all attachments from ticket

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Get Attachments by Ticket ID

Returns the metadata for all attachments currently associated with a given ticket. Each item in the response includes the attachment ID, filename, upload date, type, and the user who uploaded it. Use the returned attachment IDs with the Get Attachment by ID endpoint to download individual files.

Endpoint

GET /api/v1/tickets/getAttachmentsByTicketId

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 audit all documents submitted on a ticket or to identify which files have already been uploaded before adding new ones. This is the first step in a file-retrieval workflow — call this endpoint to get attachment IDs, then call GET /api/v1/tickets/getAttachmentById to download specific files.

Query Parameters

ParameterTypeRequiredDescription
idinteger (int32)YesMerchant profile ID associated with the ticket.
ticketIdinteger (int32)YesID of the ticket whose attachments to list.

Response

200 OK

FieldTypeDescription
dataarrayList of attachment metadata objects.
data[].idintegerUnique attachment ID. Use this with getAttachmentById.
data[].fileNamestringOriginal filename including extension.
data[].dateTimestring (date-time)ISO 8601 timestamp of when the attachment was uploaded.
data[].typestringAttachment category (e.g., VoidCheck, ProcessingStatements).
data[].riskDocumentbooleantrue if the file is flagged as a risk document.
data[].userNamestringUsername of the person who uploaded the attachment.
requestIdintegerInternal request tracking ID.
successbooleantrue if the list was retrieved successfully.
errorstringError message if the operation failed.
validationErrorsarrayList of field-level validation issues.
{
  "data": [
    {
      "id": 1034,
      "fileName": "voided_check.pdf",
      "dateTime": "2026-05-15T10:23:00Z",
      "type": "VoidCheck",
      "riskDocument": false,
      "userName": "[email protected]"
    },
    {
      "id": 1035,
      "fileName": "processing_statement_march.pdf",
      "dateTime": "2026-05-15T10:45:00Z",
      "type": "ProcessingStatements",
      "riskDocument": false,
      "userName": "[email protected]"
    }
  ],
  "requestId": 98127,
  "success": true,
  "error": null,
  "validationErrors": []
}

Error Codes

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

Common Mistakes

  • Omitting the id (merchant profile ID) parameter — it is required alongside ticketId.
  • Expecting file content in this response — this endpoint returns metadata only; use getAttachmentById to download the actual file.
  • Calling this on a ticket with no attachments and treating an empty data array as an error — an empty array with success: true is a valid response.

Related Endpoints

  • GET /api/v1/tickets/getAttachmentById — Download the content of a specific attachment using the id from this response.
  • POST /api/v1/tickets/attachment — Upload a new attachment to the ticket.
  • GET /api/v1/tickets/getTicketById — Check the hasAttachment flag before calling this endpoint.

Example

curl -X GET "https://hq.staging.netevia.dev/api/v1/tickets/getAttachmentsByTicketId?id=70269&ticketId=48291" \
  -H "Authorization: Basic $(echo -n 'username:password' | base64)"
Query Params
int32
required
int32
required
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json