Files

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. <b>Required scopes:</b> files.read

get/v2/issuers/{organizationId}/files/metadata

Request

  • Base URL: https://rewards-api.getkard.com
  • URL: https://rewards-api.getkard.com/v2/issuers/{organizationId}/files/metadata
  • Auth: HTTP bearer

Path parameters

organizationIdstring required

Your issuer organization ID, provided by Kard

Query parameters

filter[dateFrom]string

Start date for filtering files (format ISO8601). If not provided, defaults to current date minus 1 month.

filter[dateTo]string

End date for filtering files (format ISO8601). If not provided, defaults to current date.

filter[fileType]'earnedRewardApprovedDailyReconciliationFile' | 'earnedRewardSettledDailyReconciliationFile' | 'monthlyReconciliationFile'

The document file type.

page[size]integer

Number of items per page. Defaults to 10 if not specified and maximum value allowed 100 items per page.

page[after]string

Cursor for forward pagination (next page).

page[before]string

Cursor for backward pagination (previous page).

sort'sentDate' | '-sentDate'

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

Response

Response with status 200

Changes

No recorded changes to this operation across all 1 revision of this API.