List | Kard API

curl -G https://rewards-api.getkard.com/issuers/%7BorganizationId%7D/files \
     -H "Authorization: Bearer <token>" \
     -d "page[size]=1" \
     -d fileType=usersEligibilityFile

{
  "data": [
    {
      "type": "usersEligibilityFile",
      "attributes": {
        "fileName": "users_offer_eligibility_2024-01-01.json.gz",
        "lastModified": "2024-01-01T00:00:00Z",
        "contentType": "application/gzip",
        "downloadUrl": "downloadUrl-to-retrieve-file"
      },
      "id": "dXNlcnNfb2ZmZXJfZWxpZ2liaWxpdHlfMjAyNC0wMS0wMS5qc29uLmd6Cg=="
    }
  ],
  "meta": {
    "pageSize": 1
  },
  "links": {
    "self": "/issuers/:organizationId/files?fileType=usersEligibilityFile&page[size]=1",
    "first": "/issuers/:organizationId/files?fileType=usersEligibilityFile&page[size]=10&page[after]=some_pagination_token",
    "next": "/issuers/:organizationId/files?page[size]=1"
  }
}

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

Authentication

AuthorizationBearer

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

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:

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

400

Invalid Request

401

Unauthorized Error

404

Does Not Exist Error

500

Internal Server Error