GET
/
v1
/
files
List files
curl --request GET \
  --url https://api.steuerboard.com/v1/files \
  --header 'Authorization: Bearer <token>' \
  --header 'x-client-id: <x-client-id>'
{
  "data": [
    {
      "id": "cmf41ajzv003706un4i99q19z",
      "documentDate": "2021-01-01T00:00:00Z",
      "createdAt": "2021-01-01T00:00:00Z",
      "updatedAt": "2021-01-01T00:00:00Z",
      "name": "document.pdf",
      "mimetype": "application/pdf",
      "size": 1024,
      "workspaceId": "cmf41ajzv003706un4i99q19z",
      "createdById": "cmf41ajzv003706un4i99q19z",
      "taskId": "cmf41ajzv003706un4i99q19z",
      "folderId": "cmf41ajzv003706un4i99q19z",
      "labelIds": [
        "cmf41ajzv003706un4i99q19z"
      ]
    }
  ],
  "pagination": {
    "nextCursor": "cmf41ajzv003706un4i99q19z",
    "previousCursor": "cmf41ajzv003706un4i99q19z",
    "limit": 20,
    "total": 134
  }
}

Authorizations

Authorization
string
header
required

Bearer token authentication

Headers

x-client-id
string<cuid>
required

The ID of the client

Example:

"cmf41ajzv003706un4i99q19z"

Query Parameters

limit
number
default:20

The number of items to return

Required range: 1 <= x <= 100
Example:

20

cursor
string<cuid>

The cursor to return the next page of items

Example:

"cmf41ajzv003706un4i99q19z"

workspaceId
string<cuid>

Response

Paginated files

data
object[]
required
pagination
object
required