Login with email + password

POST

/api/v2/auth/login

• Production
• Sandbox (us-east-1)

Returns a JWT access token. tenantId is optional; if omitted and the user belongs to multiple tenants, the returned token is partial — call /select-tenant before tenant-scoped APIs.

Request Body ^required

object

email

required

string format: email

Example

operator@example.com

password

required

string format: password

>= 8 characters

tenantId

Optional. If user has multiple memberships and tenantId is omitted, the response is a partial token.

string

Responses

200

Authenticated

object

accessToken

string

refreshToken

string

partial

True when the token is tenant-less and /select-tenant is required next.

boolean

stale

True when membership data has changed and re-authentication is recommended.

boolean

401

Authentication required or invalid

object

error

string

Example

unauthorized

message

string