User
User Object
Field | Type | Description |
---|---|---|
id | snowflake | the user's id |
string | the user's e-mail | |
phonenumber | string | the user's mobile phone number |
firstname | string | the user's first name |
lastname | string | the user's last name |
company | string | the user's company |
position | string | the user's position at their company |
Get Logged in User
GET /users/@me
Returns the user object for the logged in user.
Get User
GET /users/{user.id}
Returns the user object for the given user id.
The fields returned will depend on the user's relationship with the organisation.
Update Current User
PATCH /users/@me
Returns the user object on success. All fields are optional.
Parameters
Field | Type | Description |
---|---|---|
phonenumber | string | the user's mobile phone number |
firstname | string | the user's first name |
lastname | string | the user's last name |
company | string | the user's company |
position | string | the user's position at their company |
Get Logged in User's Organisations
GET /users/@me/organisations
Returns a list of organisation objects that the user is a member of.
{
"id": "1234",
"name": "XMTA"
}