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
​
_id
string

Unique identifier for the user

​
role
string

Reference to the user's role

​
username
string

Unique username of the user

​
name
string

First name of the user

​
lastName
string

Last name of the user

​
fullName
string

Full name of the user

​
phone
string

Phone number of the user

​
companyName
string

Name of the user's company

​
projectNameURL
string

URL for the user's project name

​
country
string

Country of the user

​
address1
string

Primary address of the user

​
address2
string

Secondary address of the user

​
city
string

City of the user

​
region
string

Region or state of the user

​
zip
string

ZIP code of the user

​
token
string

Authentication token for the user

​
stripeAccountId
string

Stripe account ID of the user

​
stripeOnboardingDone
boolean
default:false

Indicates if Stripe onboarding is complete

​
stripeDetailsSubmitted
boolean
default:false

Indicates if Stripe details have been submitted

​
experimentalFeatures
boolean
default:false

Indicates if experimental features are enabled

​
resetToken
string

Token for resetting the user's password

​
stripeCustomer
object

Stripe customer information for the user

​
subscription
object

Subscription details for the user

​
appliedTrial
boolean
default:false

Indicates if the user has applied a trial

​
projects
string[]

List of projects associated with the user

​
groups
string[]

List of groups associated with the user

​
administrators
string[]

List of administrators associated with the user

​
editors
string[]

List of editors associated with the user

​
invites
object[]

List of invites associated with the user

​
preferences
object

User preferences

IntroductionGet Groups