Login

Authenticate with your credentials to obtain an access token.

POST
/api/v1/auth/login

Description

The login endpoint authenticates a user with their client credentials (client_id and client_secret), returning a JSON Web Token valid for 4 hours. The token should be included in the Authorization header for all subsequent API requests.

Request

Headers

HeaderValueRequired
Content-Typeapplication/jsonYes

Body Parameters

ParameterTypeRequiredDescription
client_idstringYesYour email address or client identifier
client_secretstringYesYour password or client secret

Response

Response Fields

FieldTypeDescription
messagestringStatus message indicating successful login
tokenstringJWT token valid for 4 hours

Error Responses

Common error responses you may encounter when using this endpoint.

Notes

  • Access tokens expire after 4 hours. Use the refresh token endpoint to obtain a new token without re-authenticating.
  • Always include the Bearer Token in the Authorization header for secured endpoints.
  • Failed login attempts are rate-limited to prevent brute force attacks.
  • Store tokens securely on the client-side to prevent unauthorized access. Never expose them in version control.

Related Endpoints

Did this page help you?