List

GET

/issuers/:organizationId/files

Retrieve file information for users eligibility and reconciliation files, along with file download URL links.
Required scopes: files.read

Path parameters

organizationIdstringRequired

Your organization ID, provided by Kard.

Query parameters

page[size]integerOptional

Number of records to be returned [1-100], default is 10.

page[after]stringOptional

Cursor value to retrieve next page of results if provided. Value can be received from the ‘links’ section of previous API calls.

fileTypeenumRequired

The document file type.

Allowed values: usersEligibilityFiledailyReconciliationFilemonthlyReconciliationFile

Response

This endpoint returns an object.

datalist of objects

Data and attributes related to files

metaobject

Meta information about the API call

linksobject

Related pagination links to the API call

Errors

GET

1 curl -G https://rewards-api.getkard.com/issuers/{organizationId}/files \
2      -H "Authorization: Bearer <token>" \
3      -d "page[size]"=1 \
4      -d fileType=usersEligibilityFile

200Retrieved

1 {
2   "data": [
3     {
4       "type": "usersEligibilityFile",
5       "attributes": {
6         "fileName": "users_offer_eligibility_2024-01-01.json.gz",
7         "lastModified": "2024-01-01T00:00:00Z",
8         "contentType": "application/gzip",
9         "downloadUrl": "downloadUrl-to-retrieve-file"
10       },
11       "id": "dXNlcnNfb2ZmZXJfZWxpZ2liaWxpdHlfMjAyNC0wMS0wMS5qc29uLmd6Cg=="
12     }
13   ],
14   "meta": {
15     "pageSize": 1
16   },
17   "links": {
18     "self": "/issuers/:organizationId/files?fileType=usersEligibilityFile&page[size]=1",
19     "first": "/issuers/:organizationId/files?fileType=usersEligibilityFile&page[size]=10&page[after]=some_pagination_token",
20     "next": "/issuers/:organizationId/files?page[size]=1"
21   }
22 }

Built with

1	curl -G https://rewards-api.getkard.com/issuers/{organizationId}/files \
2	-H "Authorization: Bearer <token>" \
3	-d "page[size]"=1 \
4	-d fileType=usersEligibilityFile

1	{
2	"data": [
3	{
4	"type": "usersEligibilityFile",
5	"attributes": {
6	"fileName": "users_offer_eligibility_2024-01-01.json.gz",
7	"lastModified": "2024-01-01T00:00:00Z",
8	"contentType": "application/gzip",
9	"downloadUrl": "downloadUrl-to-retrieve-file"
10	},
11	"id": "dXNlcnNfb2ZmZXJfZWxpZ2liaWxpdHlfMjAyNC0wMS0wMS5qc29uLmd6Cg=="
12	}
13	],
14	"meta": {
15	"pageSize": 1
16	},
17	"links": {
18	"self": "/issuers/:organizationId/files?fileType=usersEligibilityFile&page[size]=1",
19	"first": "/issuers/:organizationId/files?fileType=usersEligibilityFile&page[size]=10&page[after]=some_pagination_token",
20	"next": "/issuers/:organizationId/files?page[size]=1"
21	}
22	}