:) paperlesspaper docs
API ReferencePapers

Query papers by device or organization

Retrieves paper entries (screens) filtered by device or by organization when no device is provided.

Middlewares: authMiddleware, validateDeviceOrOrganizationQuery

GET
/papers/
x-api-key<token>

API key for authentication

In: header

Query Parameters

name?string

Name to filter by

role?string

Role to filter by

sortBy?string

Field to sort by

search?string

Search term to filter results

limit?integer

Number of items per page

Range1 <= value <= 100000
offset?integer|null

Offset for pagination, used to skip a number of items

Range0 <= value <= 100000
page?integer

Page number for pagination

Range1 <= value <= 100000
deviceId?string

A valid MongoDB ObjectId

organization?string

A valid MongoDB ObjectId

Response Body

application/json

curl -X GET "https://api.paperlesspaper.de/v1/papers/"
{
  "results": [
    null
  ],
  "totalResults": 100,
  "totalPages": 10,
  "page": 1,
  "limit": 10
}