Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
executable file 77 lines (66 sloc) 2.11 KB

Get the current User

Use this endpoint to get information about the currently authenticated user.

  • GET /v1/me
  • Required scope: user_read (default)

Response

{
    "id": 1,
    "email": "john@example.com",
    "username": "john_smith",
    "first_name": "John",
    "last_name": "Smith",
    "timezone": "Europe\/Warsaw",
    "last_login": "2014-07-29T08:47:32+00:00",
    "signed_up": "2012-03-28T10:30:01+00:00",
    "account_uri": "https:\/\/example.slickplan.com\/",
    "user_plan": 8,
    "user_type": "owner",
    "is_active": true
}
Key Type Description
id integer Unique identifier of the user
email string Email address of the user
username string Username of the user
first_name string First name of the user
last_name string Last name of the user
timezone string User timezone, supported list of timezones
last_login string Last login date in Atom format
signed_up string Signed up date in Atom format
account_uri string Account URI with trailing slash or empty if account has not been activated yet
user_plan integer User plan, check the table below
user_type string User type, check the table below
is_active boolean true if account is active, false if suspended

Update current user data

  • PUT /v1/me
  • Required scope: user_write

Will update the currently authenticated user information from the parameters passed and return the JSON representation of the changed settings. Possible other responses: 400 and 403.

Sample request

{
    "email": "john@example.com",
    "username": "john_smith",
    "first_name": "John",
    "last_name": "Smith",
    "timezone": "Europe\/Warsaw"
}

User plans

Name Description
1 Free
2 Basic (legacy)
3 Premium (legacy)
4 Unlimited (legacy)
5 Basic
6 Pro
7 Team
8 Agency

User types

Name Description
owner Account owner
admin An admin
contributor A contributor (editor/viewer)