Skip to navigation
API ReferenceFiles

Get Files

Retrieves metadata for files associated with a specific issuer/organization. This endpoint supports pagination and sorting options to efficiently navigate through potentially large sets of file metadata. Required scopes: files.read

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

organizationIdstringRequired
Your issuer organization ID, provided by Kard

Query parameters

filter[dateFrom]stringOptional

Start of the range, applied to the file’s original send date (sentAt), which a regenerated file keeps (format ISO8601). If not provided, defaults to current date minus 1 month.

filter[dateTo]stringOptional

End of the range, applied to the file’s original send date (sentAt), which a regenerated file keeps (format ISO8601). If not provided, defaults to current date.

filter[fileType]enumOptional

File type to return. payoutReconciliationFile and its deprecated alias monthlyReconciliationFile return the same files; type on each record echoes the name used in the filter.

Allowed values:
page[size]integerOptional
Number of items per page. Defaults to 10 if not specified and maximum value allowed 100 items per page.
page[after]stringOptional

Cursor for forward pagination (next page).

page[before]stringOptional

Cursor for backward pagination (previous page).

sortenumOptional

If provided, response will be sorted by the specified fields. Defaults to descending sentDate, equivalent to “-sentDate”

Allowed values:

Response

This endpoint returns an object.
datalist of objects

List of file metadata objects with their pre-signed URLs.

metaobject
Metadata about the pagination status.

Errors

400
Invalid Request
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error
500
Internal Server Error