Sessions

POST /auth/sign_in

Sign in with a username and password. Upon successful signin, the response headers will include Access-Token, Client, and Uid. These values must be sent with any subsequent authenticated requests.

Endpoint

POST /api/v2/auth/sign_in

Parameters

Name Description type
email required email string
password required password string

Request

Route

POST /api/v2/auth/sign_in

Headers

Accept: application/json
Content-Type: application/json

Body

{
  "email": "test@example.com",
  "password": "password"
}

Response

Status

200

Headers

Content-Type: application/json; charset=utf-8
Access-Token: FaIZ3lv_5-n7HsFxKGccsQ
Token-Type: Bearer
Client: n1CxXw9PM1N1VuylF96HiQ
Expiry: 1889903605
Uid: test@example.com

Body

{
  "user": {
    "email": "test@example.com",
    "name": "John Doe",
    "uid": "siuayACV",
    "teams": [
      {
        "name": "John Doe",
        "personal": true,
        "uid": "uMQrVFHx"
      }
    ]
  },
  "success": true
}