Skip to main content
GET
Retrieve workspace files

Authorizations

Authorization
string
header
required

Workspace API key, prefixed rqk_.

Path Parameters

url
string
required

Workspace slug.

Query Parameters

page
integer
default:1
limit
integer
default:20

Matches the file name or its extension.

status
enum<string>
default:all

Filter by whether the file's links are archived.

Available options:
all,
active,
archived
fileType
enum<string>
default:all

Filter by file family. Matching is case-insensitive, and other covers anything outside the named buckets, including files with no recorded extension.

Available options:
all,
images,
pdfs,
documents,
other
sort
enum<string>
default:newest

Result order. most-clicks ranks by the all-time clicks across a file's links.

Available options:
newest,
oldest,
most-clicks,
largest,
name-asc

Response

OK

documents
object[]
total
integer

Number of files matching the current filters.

page
integer
limit
integer