Agendize Platform API

Accounts API Reference

The Accounts API empowers you to manage one account.


Resource representation

{ "id": {string}, "firstName": {string}, "lastName": {string}, "email": {string}, "userName": {string}, "ssoToken": {string}, "profileSettings": { "preferences": { "language": "fr" "timeZone": "Europe/Paris" } }, "picture": { "url": {string}, "mimeType": {string} } }
Parameter name Value Description
id string Identifier of the account
userName string user name of the user account. The same value as the email address. Read-only
firstName string First name of the user account.
lastName string Last name of the user account.
email string Email address of the user account. Used as user name, it is not possible to change after account creation.
ssoToken string The SSO token to use to connect to API with the user account. Read-only
profileSettings object Profile settings of the user account.
profileSettings.preferences object Preferences of the user account.
profileSettings.preferences.timeZone string Time zone code of the user account. Possible values can be found here.
profileSettings.preferences.language string Spoken language of the user account.
picture object User account picture url and mime type.
picture.url string Url of the user account picture.
picture.mimeType string Mime type of the user account picture file.

Get

Return an account details.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

GET https://api.agendize.com/api/2.0/accounts

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a Account resource in the response body.