Documents
Retrieve a list of documents
Documents
Retrieve a list of documents
Retrieve all documents for the authenticated workspace.
GET
/
documents
curl --request GET \
--url https://api.reqlick.com/documents \
--header 'Authorization: Bearer <token>'
[
{
"id": "1110580a82031111aaa01111",
"name": "example.pptx",
"description": "This is an example",
"file": "Example PPTX",
"size": 38705381,
"type": ".pptx",
"createdAt": "2024-07-16T10:48:18.541Z",
"updatedAt": "2024-07-16T10:48:18.541Z",
"projectId": "1110580a82031111aaa01111",
"_count": {
"links": 100,
"views": 700
},
"createdBy": {
"name": "Example",
"image": "https://example.com/image.png",
"id": "1110580a82031111aaa01111"
},
"views": [
{
"id": "1110580a82031111aaa01111"
}
],
"links": [
{
"id": "1110580a82031111aaa01111",
"documentId": "1110580a82031111aaa01111",
"url": "<string>",
"key": "sport",
"expiresAt": "2023-11-07T05:31:56Z",
"password": "<string>",
"proxy": true,
"isFile": true,
"isQR": true,
"title": "Instant File Sharing Link with Reqlick",
"description": "Turn your files into shareable links and connect effortlessly",
"image": "/thumbnail.png",
"allowedEmails": [
"<string>"
],
"createdAt": "2024-07-16T10:48:19.492Z",
"updatedAt": "2024-07-16T10:48:19.492Z",
"projectId": "1110580a82031111aaa01111",
"isPublic": true,
"isActive": true,
"isArchived": false,
"isRecord": false,
"domain": "rqk.sh",
"utm_source": null,
"utm_medium": null,
"utm_campaign": null,
"utm_term": null,
"utm_content": null,
"ref": null,
"ios": null,
"android": null,
"tagId": null,
"createdSessionId": null
}
]
}
]
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Workspace url
Response
200
application/json
Get all documents
The response is of type object[]
.
curl --request GET \
--url https://api.reqlick.com/documents \
--header 'Authorization: Bearer <token>'
[
{
"id": "1110580a82031111aaa01111",
"name": "example.pptx",
"description": "This is an example",
"file": "Example PPTX",
"size": 38705381,
"type": ".pptx",
"createdAt": "2024-07-16T10:48:18.541Z",
"updatedAt": "2024-07-16T10:48:18.541Z",
"projectId": "1110580a82031111aaa01111",
"_count": {
"links": 100,
"views": 700
},
"createdBy": {
"name": "Example",
"image": "https://example.com/image.png",
"id": "1110580a82031111aaa01111"
},
"views": [
{
"id": "1110580a82031111aaa01111"
}
],
"links": [
{
"id": "1110580a82031111aaa01111",
"documentId": "1110580a82031111aaa01111",
"url": "<string>",
"key": "sport",
"expiresAt": "2023-11-07T05:31:56Z",
"password": "<string>",
"proxy": true,
"isFile": true,
"isQR": true,
"title": "Instant File Sharing Link with Reqlick",
"description": "Turn your files into shareable links and connect effortlessly",
"image": "/thumbnail.png",
"allowedEmails": [
"<string>"
],
"createdAt": "2024-07-16T10:48:19.492Z",
"updatedAt": "2024-07-16T10:48:19.492Z",
"projectId": "1110580a82031111aaa01111",
"isPublic": true,
"isActive": true,
"isArchived": false,
"isRecord": false,
"domain": "rqk.sh",
"utm_source": null,
"utm_medium": null,
"utm_campaign": null,
"utm_term": null,
"utm_content": null,
"ref": null,
"ios": null,
"android": null,
"tagId": null,
"createdSessionId": null
}
]
}
]