> This page is for version Legacy.
> For other versions, use one of these documentation indexes:
> - 2024-10-01 (default): https://docs.getkard.com/2024-10-01/llms.txt
> - Legacy: https://docs.getkard.com/legacy/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.getkard.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.getkard.com/_mcp/server.

# List

GET https://rewards-api.getkard.com/issuers/{organizationId}/files

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

Reference: https://docs.getkard.com/legacy/api/files/list

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Servers

- `https://rewards-api.getkard.com` (Production, default)
- `https://test-rewards-api.getkard.com` (Sandbox)

## Request

### Path parameters

- `organizationId` (string, required) — Your organization ID, provided by Kard.

### Query parameters

- `page[size]` (integer, optional) — Number of records to be returned [1-100], default is 10.
- `page[after]` (string, optional) — Cursor value to retrieve next page of results if provided. Value can be received from the 'links' section of previous API calls.
- `fileType` (enum, required) — The document file type.
  - Allowed values: `usersEligibilityFile`, `dailyReconciliationFile`, `monthlyReconciliationFile`

## Response

### 200

- `data` (list of File, required) — Data and attributes related to files
- `meta` (FilesMeta, required) — Meta information about the API call
- `links` (PaginationLinks, required) — Related pagination links to the API call

## Errors

### 400 Invalid Request

- `InvalidRequestUnion`

### 404 Does Not Exist Error

- `string`

### 500 Internal Server Error

- `string`

### 401 Unauthorized Error

- `message` (string, required)

## Types

### File

Type of document returned. Will always be type file

- `type`: `usersEligibilityFile`
  - `attributes` (FileAttributes, required)
  - `id` (string, required) — The File ID in Kard’s system
- `type`: `dailyReconciliationFile`
  - `attributes` (FileAttributes, required)
  - `id` (string, required) — The File ID in Kard’s system
- `type`: `monthlyReconciliationFile`
  - `attributes` (FileAttributes, required)
  - `id` (string, required) — The File ID in Kard’s system

### FilesMeta

- `pageSize` (integer, required) — The number of records returned in API call.

### PaginationLinks

Related pagination links to the API call.

- `self` (string, required) — The self link. Will point to the current URL.
- `first` (string, required) — The URL to get the first page of results.
- `next` (string, optional) — The URL to get the next page of results.

### RequestValidationErrorResponse

- `errors` (list of string, required)

### FileAttributes

- `fileName` (string, required) — The name of the file to download.
- `lastModified` (datetime, required) — The last time this document was modified (ISO 8601).
- `contentType` (string, required) — The content type of the file.
- `downloadUrl` (string, required) — The download link of the file. Use this to download the associated file. These are ephemeral links with an expiration time of 1 hour.

## Examples

**Response**

```json
{
  "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"
  }
}
```

**SDK Code**

```python
import requests

url = "https://rewards-api.getkard.com/issuers/%7BorganizationId%7D/files"

querystring = {"page[size]":"1","fileType":"usersEligibilityFile"}

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://rewards-api.getkard.com/issuers/%7BorganizationId%7D/files?page%5Bsize%5D=1&fileType=usersEligibilityFile';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://rewards-api.getkard.com/issuers/%7BorganizationId%7D/files?page%5Bsize%5D=1&fileType=usersEligibilityFile"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://rewards-api.getkard.com/issuers/%7BorganizationId%7D/files?page%5Bsize%5D=1&fileType=usersEligibilityFile")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://rewards-api.getkard.com/issuers/%7BorganizationId%7D/files?page%5Bsize%5D=1&fileType=usersEligibilityFile")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://rewards-api.getkard.com/issuers/%7BorganizationId%7D/files?page%5Bsize%5D=1&fileType=usersEligibilityFile', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://rewards-api.getkard.com/issuers/%7BorganizationId%7D/files?page%5Bsize%5D=1&fileType=usersEligibilityFile");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://rewards-api.getkard.com/issuers/%7BorganizationId%7D/files?page%5Bsize%5D=1&fileType=usersEligibilityFile")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```