Files
/files
List supported GL files for the current team.
Authorization
apiKey X-API-Key<token>
API key provided in dashboard
In: header
Query Parameters
search?string
Filter files by filename text match.
type?string
Filter files by their upload purpose.
Value in
"userUpload" | "ownerStatementExample"sortBy?string
Field to sort files by.
Default
"createdAt"Value in
"filename" | "startDate" | "endDate" | "createdAt" | "contactName"sortDirection?string
Sort direction.
Default
"desc"Value in
"asc" | "desc"limit?number
Default
100Range
1 <= value <= 250page?number
Default
1Range
1 <= valueoffset?number
Range
0 <= valueResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.vrplatform.app/files"{
"data": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"filename": "string",
"type": "userUpload",
"startDate": "string",
"endDate": "string",
"createdAt": "2024-01-15T12:30:00.000+00:00",
"contact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"firstName": "string",
"uniqueRef": "string",
"shortRef": "string",
"email": "user@example.com",
"type": "owner"
}
}
],
"pagination": {
"limit": 100,
"page": 1,
"total": 0,
"totalPage": 0,
"nextPage": 0
}
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"context": null
}