Skip to main content
GET
/
api
/
shelves
List shelves
curl --request GET \
  --url https://api.shelv.dev/api/shelves \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "createdAt": "2023-11-07T05:31:56Z",
      "errorMessage": "<string>",
      "failedAtStep": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "mimeType": "<string>",
      "name": "<string>",
      "originalFileName": "<string>",
      "pageCount": 123,
      "reviewMode": true,
      "s3Prefix": "<string>",
      "status": "uploading",
      "storageSizeBytes": 123,
      "template": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "userId": "<string>"
    }
  ],
  "pagination": {
    "limit": 123,
    "page": 123,
    "total": 123,
    "totalPages": 123
  }
}

Authorizations

Authorization
string
header
required

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

Query Parameters

page
integer
default:1
limit
integer
default:20
Required range: x <= 100

Response

Paginated list of shelves

data
object[]
required
pagination
object
required