Skip to main content
GET
/
files
Retrieve a list of files
curl --request GET \
  --url https://api.supaqr.com/files \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "size": 123,
    "createdAt": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
ids
string[]

IDs of files to filter by. eg. ids=id1&ids=id2

​
search
string

The search term to filter the files by.

Required string length: 1 - 200
​
ext
string

The file extension indicating the format (e.g., "png", "pdf")

Required string length: 1 - 20
​
sortBy
enum<string>
default:created_at

The field to sort the files by.

Available options:
name,
created_at
​
sortOrder
enum<string>
default:desc

The order to sort the files by.

Available options:
asc,
desc
​
page
integer<int32>
default:1

The page number for pagination.

Required range: x >= 1
​
pageSize
integer<int32>
default:20

The number of files per page.

Required range: 1 <= x <= 100
​
showArchived
boolean
default:false

Whether to include archived files in the response.

Response

​
id
string
required
​
name
string
required
​
size
integer<int32>
required
​
createdAt
string<date-time>
required