Skip to main content

Sign in

POST 
/auth/sign-in

Authenticate with username and password. If multi-factor authentication is enabled, also send the totp code from your authenticator app.

The response's tokens object contains accessToken, used to authenticate subsequent API requests, and refreshToken, used to renew access. The customer object describes your environment, including its name and modules; user contains information about the authenticated user.

The documented default lifetime of an access token is 30 minutes. Use Refresh access token after it expires. For automated integrations, see the API overview.

Request​

Responses​