Login

Authenticate a customer and receive an authentication token.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

Authenticate an existing customer with their email (or username) and password, and return a JWT that authenticates them on protected endpoints.

Example: A returning subscriber signs in with their email and password. On success you receive their profile and a token to use for the rest of their session.

📘

Invalid credentials are not disclosed

A wrong password, an unknown email, and an unknown username all return the same 404Invalid credentials! Please try again. The API never reveals whether an account exists.

🚧

Lockout

After repeated failed attempts (10 by default, within a 5-minute window) further attempts are temporarily blocked with a “Too many login attempts” error until the window passes.


Conditional Requirements

ConditionRequired Fields
Alwayspassword
Alwaysemail OR username
Query Params
int32
required

The unique identifier of the site associated with your account.

Body Params
string
required

The password

string

The email identifying the customer under the site. Required if the username is not provided.

string

The username identifying the customer under the site. Required if the email is not provided.

Responses

Language
Credentials
Query
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json