Login with email and password.

POST 
/users/login

This should not be used by most API consumers, who should generate API tokens using the login page and use bearer authentication. This endpoint allows bootstrapping the API via login to generate more API tokens.

Request

application/json

Body

required

email stringrequired

the email address

password stringrequired

the password

Responses

200

OK

Response Headers

• Set-Cookie string

application/json

Schema

Schema

id numberrequired

User ID

email stringrequired

Email address of the user

role stringrequired

Role of the user

token stringdeprecated

Legacy access token, will be null for new accounts and eventually deleted.

credits_remaining numberrequired

Remaining credits for this user

invoice_allowed booleanrequired

Is this user post-paid?

out_of_credits_threshold integerrequired

Threshold for out-of-credits notification. If the threshold gets crossed with a task, then we trigger an email.

terms_of_service_version stringrequired

Version string of the terms of service that the user has accepted

Example (from schema)

{
  "id": 0,
  "email": "string",
  "role": "string",
  "credits_remaining": 0,
  "invoice_allowed": true,
  "out_of_credits_threshold": 0,
  "terms_of_service_version": "string"
}

Loading...