POST
/
users
/
login
curl --request POST \
  --url https://app.planpoint.io/api/users/login \
  --header 'Authorization: <api-key>'
{
  "_id": "<string>",
  "role": "<string>",
  "username": "<string>",
  "name": "<string>",
  "lastName": "<string>",
  "fullName": "<string>",
  "phone": "<string>",
  "companyName": "<string>",
  "projectNameURL": "<string>",
  "country": "<string>",
  "address1": "<string>",
  "address2": "<string>",
  "city": "<string>",
  "region": "<string>",
  "zip": "<string>",
  "token": "<string>",
  "stripeAccountId": "<string>",
  "stripeOnboardingDone": false,
  "stripeDetailsSubmitted": false,
  "experimentalFeatures": false,
  "resetToken": "<string>",
  "stripeCustomer": {},
  "subscription": {},
  "appliedTrial": false,
  "projects": [
    "<string>"
  ],
  "groups": [
    "<string>"
  ],
  "administrators": [
    "<string>"
  ],
  "editors": [
    "<string>"
  ],
  "invites": [
    {
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "jsmith@example.com",
      "level": "<string>"
    }
  ],
  "preferences": {
    "hideBrandingIcon": false,
    "hideLoadingLogo": false
  }
}

Authorizations

Authorization
string
header
required

Query Parameters

username
string
required

The user name for login

password
string
required

The password for login

Response

200
application/json
Successful operation

The response is of type object.