Sign In

Signin

POST /v2/sessions/signin

---

Body

Request Properties

Name	Type	Description	Required
email	string	The user email.	Yes
password	string	The user password.	Yes

Example Request

{
  "email": "[email protected]",
  "password": "test"
}

---

Response

Response properties

Name	Type	Description
authServerToken	string	Authentication Token
user	object	See Get User route for User definition

Example Response

{
  "id": 1135,
  "uuid": "80fbd8db-6e7e-4e5b-bdb3-6e9a768471ec",
  "firstName": "Sterling",
  "lastName": "Archer",
  "email": "[email protected]",
  "phone": "",
  "organizationID": 1,
  "defaultAppID": 0,
  "defaultAppURL": "",
  "icon": "",
  "active": true,
  "services": {
    "account": [
      "anon",
      "auth"
    ],
    "customer-api": [
      "anon",
      "customer"
    ],
    "locations": [
      "anon",
      "customer"
    ],
    "quote-service": [
      "anon",
      "csr"
    ]
  },
  "impersonate": false,
  "token": "bxkpIVEBdHvkeBgcd1Hy7sfBOO9TlrbopaPtDGnUfy3HiDcVKemgVaKJI4fkhvD5",
  "authServerToken": "bxkpIVEBdHvkeBgcd1Hy7sfBOO9TlrbopaPtDGnUfy3HiDcVKemgVaKJI4fkhvD5",
  "pending": false,
  "createdAt": "2023-05-02T17:49:50Z",
  "updatedAt": "2023-05-16T15:26:23Z",
  "organizations": [
    {
      "id": 1,
      "ownerID": 1,
      "name": "White Arrow Inc",
      "token": "",
      "organizationType": "Customer",
      "referenceID": 1,
      "relationID": 1,
      "ownerFullName": "Sterling Archer",
      "ownerEmail": "[email protected]"
    }
  ],
  "groups": null,
  "organizationGroups": null,
  "verificationCodes": null
}