docs

Auth

Sign-in, sign-out, and session lifecycle.

On this page

Sign in

Exchange email and password for a tenant session JWT or a short-lived pre-auth token when two-factor authentication is required.

Technical details

Exact HTTP method and path your client calls

post/auth/login

Request body

FieldTypeDescription
emailrequiredstring
passwordrequiredstring
intentstring
enum: tenant

Responses

Login successful: either tenant JWT, or 2FA challenge (preAuthToken)

FieldTypeDescription
(union)LoginTokenResponse | LoginTwoFactorChallenge
Example
null

Errors return the standard envelope. See error reference.

Code samples

curl --request POST \
  --url 'https://api.not24get.me/auth/login' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "string",
  "password": "string",
  "intent": "tenant"
}'

Try it

Request body (JSON)

Refresh session

Exchange a refresh token for a new access token without re-entering credentials.

Technical details

Exact HTTP method and path your client calls

post/auth/refresh

Request body

FieldTypeDescription
refreshTokenstring
sessionstring
enum: tenant

Responses

New access and refresh tokens

FieldTypeDescription
accessTokenstring
refreshTokenstring
tokenTypestring
enum: tenant
canManageBillingboolean
Example
{
  "accessToken": "string",
  "refreshToken": "string",
  "tokenType": "tenant",
  "canManageBilling": false
}

Errors return the standard envelope. See error reference.

Code samples

curl --request POST \
  --url 'https://api.not24get.me/auth/refresh' \
  --header 'Content-Type: application/json' \
  --data '{
  "refreshToken": "string",
  "session": "tenant"
}'

Try it

Request body (JSON)