API ReferenceFiles

List Files

Returns metadata (including size) for files owned by the authenticated sales channel, optionally filtered by a set of ids and/or a purpose.

Authentication

x-truemed-api-keystring

Sales channel API key for merchant server-to-server authentication

Query parameters

pageintegerOptional
Optional field indicating which page to access. Defaults to 1.
page_sizeintegerOptional
Optional field indicating the number of records per page. Defaults to 30.
idslist of stringsOptional

Comma-separated file ids to fetch, e.g. id1,id2.

purposestringOptional

Restrict to files of this purpose, e.g. dispute_evidence.

Response

Successful response
fileslist of objects
Files owned by the authenticated sales channel matching the filters.
paginationobject or null
A pagination object with information about the current page, page size, total count, and last page.

Errors

400
Bad Request Error
404
Not Found Error
405
Method Not Allowed Error
500
Internal Server Error
501
Not Implemented Error