Collectoh
EN

This page is in English only for now. The main pages follow your choice.

Sign up free
Browse the docs

API reference

Home

The home screen and its layout (P3-19, P5-05).

Paths are relative to /api/v1 on your server.

GET/home#

The home screen

Authorisation
Bearer token or API key · Session cookie
  • 200Success. application/json · HomeResponse
  • 401UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope
  • 403FORBIDDEN: the account lacks library:view, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope
GET/home-layouts#

Read my layout

Authorisation
Bearer token or API key · Session cookie
  • 200Success. application/json · HomeLayout
  • 401UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope
  • 403FORBIDDEN: the account lacks library:view, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope
PUT/home-layouts#

Save my layout

Authorisation
Bearer token or API key · Session cookie
Body
application/json · object
  • 200Success. application/json · HomeLayout
  • 400VALIDATION_FAILED: the request did not match the schema; details.issues lists what. application/json · ErrorEnvelope
  • 401UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope
  • 403FORBIDDEN: the account lacks library:view, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope
DELETE/home-layouts#

Go back to the server default

Authorisation
Bearer token or API key · Session cookie
  • 204Done; no body.
  • 401UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope
  • 403FORBIDDEN: the account lacks library:view, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope
POST/home/preview#

Preview a layout

Authorisation
Bearer token or API key · Session cookie
Body
application/json · object
  • 200Success. application/json · HomeResponse
  • 400VALIDATION_FAILED: the request did not match the schema; details.issues lists what. application/json · ErrorEnvelope
  • 401UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope
  • 403FORBIDDEN: the account lacks library:view, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope