Log in with email and password

POST

/api/v1/auth/login

curl --request POST \
  --url https://api.pitch2sale.com/api/v1/auth/login \
  --header 'Content-Type: application/json' \
  --data '{ "email": "hello@example.com", "password": "example" }'

Returns a short-lived access token and sets the httpOnly refresh-token cookie. For server-to-server calls use a personal access token instead.

Request Body^required

Media typeapplication/json

object

email

required

string format: email

password

required

string

>= 1 characters

Example^generated

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

Responses

200

The session

Media typeapplication/json

object

user

required

object

_id

required

string

email

required

string

key

additional properties

any

org

required

object

_id

required

string

features

required

object

key

additional properties

boolean

key

additional properties

any

accessToken

required

string

Example^generated

{
  "user": {
    "_id": "example",
    "email": "example"
  },
  "org": {
    "_id": "example",
    "features": {
      "additionalProperty": true
    }
  },
  "accessToken": "example"
}

400

Validation failed

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Rate limit exceeded

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}