Skip to content

Endpoint index

Every route on https://api.postlyra.com, generated from the router itself.

"Bearer token" means the endpoint needs an Authorization header. "Brand-scoped" means it also reads X-Postlyra-Brand.

Authentication

MethodPathAuthNotes
DELETE/auth/accountBearer token
POST/auth/loginNone10 per 1 min
POST/auth/logoutBearer token
GET/auth/meBearer token
GET/auth/passkeysBearer token
POST/auth/passkeysBearer token10 per 1 min
POST/auth/passkeys/loginNone10 per 1 min
POST/auth/passkeys/login/optionsNone10 per 1 min
POST/auth/passkeys/optionsBearer token10 per 1 min
DELETE/auth/passkeys/{passkeyId}Bearer token
PATCH/auth/profileBearer token
POST/auth/registerNone10 per 1 min
DELETE/auth/two-factorBearer token10 per 1 min
GET/auth/two-factorBearer token10 per 1 min
POST/auth/two-factor-challengeNone10 per 1 min
POST/auth/two-factor/confirmBearer token10 per 1 min
POST/auth/two-factor/recovery-codesBearer token10 per 1 min
POST/auth/two-factor/setupBearer token10 per 1 min

Brands

MethodPathAuthNotes
GET/teamsBearer token
GET/teams/{id}Bearer token
PATCH/teams/{id}Bearer token

Current user

MethodPathAuthNotes
GET/me/entitlementsBearer tokenbrand-scoped
PATCH/me/teamBearer token

Ideas

MethodPathAuthNotes
POST/ideas/importBearer tokenbrand-scoped
GET/ideas/mining-contextBearer tokenbrand-scoped

Media

MethodPathAuthNotes
GET/mediaBearer tokenbrand-scoped
POST/mediaBearer tokenbrand-scoped
DELETE/media/{id}Bearer tokenbrand-scoped

Members

MethodPathAuthNotes
GET/usersBearer tokenbrand-scoped
POST/usersBearer tokenbrand-scoped
GET/users/rolesBearer tokenbrand-scoped

Notification preferences

MethodPathAuthNotes
GET/notification-preferencesBearer tokenbrand-scoped
PUT/notification-preferencesBearer tokenbrand-scoped

Device tokens

MethodPathAuthNotes
DELETE/device-tokensBearer tokenbrand-scoped
POST/device-tokensBearer tokenbrand-scoped

Subscription

MethodPathAuthNotes
POST/subscription/checkoutBearer tokenbrand-scoped
GET/subscription/plansBearer tokenbrand-scoped
GET/subscription/statusBearer tokenbrand-scoped
POST/subscription/switchBearer tokenbrand-scoped

Public

MethodPathAuthNotes
GET/public/plansNone

Other

MethodPathAuthNotes
GET/None

Notes

POST /teams appears on the router but its handler is not implemented, so calling it errors. Create a brand in Studio instead.

GET /auth/two-factor is the one endpoint under /auth/two-factor/ that is not throttled, since clients poll it to render the security screen.

Postlyra, by MAVA Design