Skip to content
All docs pages

API docs

Authentication

Sign in, send the token, refresh it before it expires.

Every request except sign-in is authenticated with a bearer token that belongs to a user. What it can do depends on that user’s role.

Sign in

  • POST/auth/loginReturns the user, their role and permissions, and an access and refresh token.

Body

NameDetails
emailrequiredThe user's work email.
passwordrequiredTheir password.
subdomainrequiredYour workspace name.

Send the token

http
Authorization: Bearer YOUR_ACCESS_TOKEN

Refresh it

Access tokens are short-lived, about 15 minutes. Exchange the refresh token for a new pair instead of signing in again.

  • POST/auth/refreshReturns a new access token and refresh token.

Body

NameDetails
refreshTokenrequiredThe refresh token from sign-in or the last refresh.