The User-API provides access to your profile data. You can read your profile, update it and change your password using the API.
To access the API endpoints you need an API token with the OAuth scope profile
. Find out how to create an API token.
Profile related operations
Name | Data Type | Description |
---|---|---|
x-apitree-password
|
string Minimum: 6 |
The user password. Required for |
Name | Data Type | Description |
---|---|---|
ErrorResponse
|
object |
message
|
string |
Response message containing detailed information about the error |
code
|
integer |
{
"code": 401,
"message": "Access denied"
}
Name | Data Type | Description |
---|---|---|
Profile
|
object |
createdAt
|
dateTime Read-only |
UTC timestamp the user was created - ISO 8601 |
company
|
string Maximum: 120 |
The company name the user is working for |
webUrl
|
string |
An absolute URL to the user's personal site / blog |
pictureUrl
|
string |
An absolute URL to the user's picture, photo, or avatar / the organization's logo |
location
|
string Maximum: 120 |
The city in which the user is located |
countryCode
|
string Minimum: 2 Maximum: 2 |
The country/region in which the user is located as ISO-3166 2-letter country code - e.g. |
displayName
|
string Maximum: 120 |
The name displayed for the user / organization. |
emailVerified
|
boolean Default value: false
|
Flag to check if the user has verified his email address |
email
|
string |
Primary email address. Optional for organizations created by the |
nickname
|
string Maximum: 60 |
URI compliant username in ASCII format. Allowed characters are lower case (a-z), upper case (A-Z), digits (0-9), hyphens (-), dots (.) and underscore (_). The nickname must be unique regardless of upper and lower case. |
accountType
|
string Default value: user Allowed values: - user - organization |
The type of the account |
id
|
string Read-only |
Unique user |
{
"id": "100001",
"accountType": "user",
"nickname": "nils",
"email": "nils.friedrichs@apitree.com",
"emailVerified": true,
"displayName": "Nils Friedrichs",
"firstname": "Nils",
"lastname": "Friedrichs",
"countryCode": "DE",
"location": "Berlin",
"webUrl": "https:\/\/www.friedrichs-it.de",
"company": "APITree",
"createdAt": "2017-10-01T10:10:10+00:00"
}
Name | Data Type | Description |
---|---|---|
Profile
|
object |
createdAt
|
dateTime Read-only |
UTC timestamp the user was created - ISO 8601 |
company
|
string Maximum: 120 |
The company name the user is working for |
webUrl
|
string |
An absolute URL to the user's personal site / blog |
pictureUrl
|
string |
An absolute URL to the user's picture, photo, or avatar / the organization's logo |
location
|
string Maximum: 120 |
The city in which the user is located |
countryCode
|
string Minimum: 2 Maximum: 2 |
The country/region in which the user is located as ISO-3166 2-letter country code - e.g. |
displayName
|
string Maximum: 120 |
The name displayed for the user / organization. |
emailVerified
|
boolean Default value: false
|
Flag to check if the user has verified his email address |
email
|
string |
Primary email address. Optional for organizations created by the |
nickname
|
string Maximum: 60 |
URI compliant username in ASCII format. Allowed characters are lower case (a-z), upper case (A-Z), digits (0-9), hyphens (-), dots (.) and underscore (_). The nickname must be unique regardless of upper and lower case. |
accountType
|
string Default value: user Allowed values: - user - organization |
The type of the account |
id
|
string Read-only |
Unique user |
{
"id": "100001",
"accountType": "user",
"nickname": "nils",
"email": "nils.friedrichs@apitree.com",
"emailVerified": true,
"displayName": "Nils Friedrichs",
"firstname": "Nils",
"lastname": "Friedrichs",
"countryCode": "DE",
"location": "Berlin",
"webUrl": "https:\/\/www.friedrichs-it.de",
"company": "APITree",
"createdAt": "2017-10-01T10:10:10+00:00"
}
Name | Data Type | Description |
---|---|---|
ErrorResponse
|
object |
message
|
string |
Response message containing detailed information about the error |
code
|
integer |
{
"code": 401,
"message": "Access denied"
}
Name | Data Type | Description |
---|---|---|
message
|
string |
Response message containing detailed information about the error |
code
|
integer |
{
"code": 401,
"message": "Access denied"
}
Name | Data Type | Description |
---|---|---|
createdAt
|
dateTime Read-only |
UTC timestamp the user was created - ISO 8601 |
company
|
string Maximum: 120 |
The company name the user is working for |
webUrl
|
string |
An absolute URL to the user's personal site / blog |
pictureUrl
|
string |
An absolute URL to the user's picture, photo, or avatar / the organization's logo |
location
|
string Maximum: 120 |
The city in which the user is located |
countryCode
|
string Minimum: 2 Maximum: 2 |
The country/region in which the user is located as ISO-3166 2-letter country code - e.g. |
displayName
|
string Maximum: 120 |
The name displayed for the user / organization. |
emailVerified
|
boolean Default value: false
|
Flag to check if the user has verified his email address |
email
|
string |
Primary email address. Optional for organizations created by the |
nickname
|
string Maximum: 60 |
URI compliant username in ASCII format. Allowed characters are lower case (a-z), upper case (A-Z), digits (0-9), hyphens (-), dots (.) and underscore (_). The nickname must be unique regardless of upper and lower case. |
accountType
|
string Default value: user Allowed values: - user - organization |
The type of the account |
id
|
string Read-only |
Unique user |
{
"id": "100001",
"accountType": "user",
"nickname": "nils",
"email": "nils.friedrichs@apitree.com",
"emailVerified": true,
"displayName": "Nils Friedrichs",
"firstname": "Nils",
"lastname": "Friedrichs",
"countryCode": "DE",
"location": "Berlin",
"webUrl": "https:\/\/www.friedrichs-it.de",
"company": "APITree",
"createdAt": "2017-10-01T10:10:10+00:00"
}
'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1
JWT token from the Auth-API
Flow:password
https://auth-api.apitree.com/oauth2/token
profile
: View basic profile dataName | ApiTree GmbH |
support@apitree.com |
API Version | 1.2.2 |