For every authenticated request (all but /sessions, /oauth and /password-resets) you need to send the auth_token (see /sessions endpoint) in the Authorization header as a Bearer token.
You can create a new session and get the auth_token and other important informations about the just logged in user by sending the email and password to this endpoint.
The returned role can be “admin”, “supervisor”, “employee” or “department_manager”.
POST Attributes
Parameter
Description
email
Email for session
password
Password for session
Response Attributes
Parameter
Description
firstname
Firstname of the sessions user
lastname
Lastname of the sessions user
email
Email of the sessions user
gender
The gender of the sessions user (male, female, divers)
locale
Locale of the sessions user
image_url
Url to the profile image of the sessions user
role
Role of the sessions user (admin, department_manager or employee)
auth_token
Auth token for users session, use this for further authorization on endpoints
company_id
ID of the company, the user belongs to. null if the user does’t belong to a company, yet.
department_id
ID of the department, the user belongs to. null if the user doesn’t belong to a department.
mood_creation_notification_email_active
Will the user receive notifications for mood reviews per email?
mood_creation_reminder_email_active
Will the user receive reminder for mood reviews per email if he didn’t give an answer already?
This will logout the user and regenerates the users api_access_token.
To retrieve the new api_access_token you need to create a new user session using the create endpoint above.
Companies
Retrieve the company stats for given company id
Returns with an 401 if the user does not belong to the company or isn’t an
admin of the company.
HTTP/1.1200OKContent-Type:application/json{"data":[{"id":"f7559f2a-8f1c-461e-8a9b-7efea5564edb","type":"custom_tags","attributes":{"name":"Workload","archived":"false","labels":{"de":"Auslastung","en":"Workload","fr":"Charge de travail","es":"Carga de trabajo","it":"Carico di lavoro","nl":"Werkbelasting","pl":"Obciążenie pracą","pt":"Carga de trabalho","ru":"Рабочая нагрузка"},"descriptions":{"de":"Auslastung","en":"Workload","fr":"Charge de travail","es":"Carga de trabajo","it":"Carico di lavoro","nl":"Werkbelasting","pl":"Obciążenie pracą","pt":"Carga de trabalho","ru":"Рабочая нагрузка"},"de_translation":"Auslastung","en_translation":"Workload","fr_translation":"Charge de travail"}},{"id":"c23e5e7d-162f-4fdc-9243-5e6349ce2bd1","type":"custom_tags","attributes":{"name":"Privat","labels":{"de":"Privat","en":"Private","fr":"Privé","es":null,"it":null,"nl":null,"pl":null,"pt":null,"ru":null},"descriptions":{"de":"Privat","en":"Private","fr":"Privé","es":null,"it":null,"nl":null,"pl":null,"pt":null,"ru":null},"de_translation":"Privat","en_translation":"Private","fr_translation":"Privé"}},{"id":"a9767fd1-a187-40e2-954c-872cebff5e70","type":"custom_tags","attributes":{"name":"Management","archived":"true","labels":{"de":"Führungskräfte","en":"Managers","fr":"Managers / Responsables","es":"personal directivo","it":"Personale direttivo","nl":"Leidinggevenden","pl":"Menedżerowie","pt":"Gerentes","ru":"Менеджеры"},"descriptions":{"de":"Führungskräfte","en":"Managers","fr":"Managers / Responsables","es":"personal directivo","it":"Personale direttivo","nl":"Leidinggevenden","pl":"Menedżerowie","pt":"Gerentes","ru":"Менеджеры"},"de_translation":"Vorgesetzte","en_translation":"Management","fr_translation":"Responsables"}}]}
GET META Attributes
Paramteter
Description
include_archived
optional
Should response include archived custom tags as well? (default: false)
Response Attributes
Paramteter
Description
id
id of the tag (used for custom_tag_ids in mood creation)
name
name (DEPRECATED)
archived
Is this custom tag available for usage or already archived
labels
An object of translations of the custom tag name.
descriptions
An object of translations of the custom tag description.
de_translation
German translation of the tag (DEPRECATED)
en_translation
English translation of the tag (DEPRECATED)
fr_translation
English translation of the tag (DEPRECATED)
Comments (for chat)
Create a new comment for a discussion
POST/commentsHTTP/1.1Host:api.company-mood.comContent-Type:application/jsonAccept:application/vnd.company-mood-v2+jsonAuthorization:Bearer 795665b4-53da-468c-a0d7-ab2d82e58406X-App-Token:27f50875-9a43-4d6c-a376-6968f09858db{"data":{"type":"comments","attributes":{"discussion_id":"679c5ffb-2d81-4608-8c4d-0f373b6f1401","comment":{"content":"Happy to hear from you."}}}}
HTTP/1.1201CREATEDContent-Type:application/json{"data":{"id":"8437","attributes":{"content":"Happy to hear from you.","created_at":"10.09.2020","author_name":"Anonym","author_image":"assets/defaults/user/mini-avatar-287e30a2e7e10a75d7afc0731799d16a58ce47c07b14fb3e8af573b9dac8f0c4.png"},"type":"comments"}}
POST Attributes
Parameter
Description
discussion_id
required
Id of the discussion you want to post to
comment[content]
required
Comment you want to post
Response Attributes
Paramteter
Description
id
Id of the comment
content
Content of the comment
created_at
Creation date of the comment
author_name
Name of the comments creator
author_image
Image URL of the comments creator
Discussions
Retrieve the logged in users discussions
Discussions are the chats a user is participating in.
HTTP/1.1200OKContent-Type:application/json{"data":[{"id":"f7559f2a-8f1c-461e-8a9b-7efea5564edb","type":"departments","attributes":{"name":"Services","breadcrumb":"Development > In House > Services"}},{"id":"a9767fd1-a187-40e2-954c-872cebff5e70","type":"departments","attributes":{"name":"Management","breadcrumb":"Management"}}]}
Response Attributes
Paramteter
Description
id
id of the department
name
name
breadcrumb
All names in path to the department incl. it’s own
Delete a specific department (by department_id in the URI)
Important!
The subdepartment children get added to the parent of this deleted department.
If the deleted department is root, then rootify the orphan subdepartments.
EventPins
Retrieve the event_pins of the users company
Returns with an 401 if the user does not belong to a company.
HTTP/1.1200OKContent-Type:application/json{"data":[{"id":"f7559f2a-8f1c-461e-8a9b-7efea5564edb","type":"event_pins","attributes":{"name":"New office manager","description":"The new office manager got employed.","date":"2016-03-11","visible_for_role":"employee","department_ids":["094822c8-d81f-4639-8197-9a586f10edcd"]}},{"id":"a9767fd1-a187-40e2-954c-872cebff5e70","type":"event_pins","attributes":{"name":"Off-Site in Berlin","description":"We spend a week in Berlin together.","date":"2016-05-27","visible_for_role":"department_manager","department_ids":[]}}]}
Response Attributes
Paramteter
Description
id
id of the department
name
Name of the event pin
description
Description of the event pin
department_ids
Department ids for departments the event pin belong. Belongs to whole company if empty
date
Date of the event pin
visible_for_role
Shows what users should be able to see it.
Oauth
Sign in via google oauth2
POST/oauth/google_oauth2HTTP/1.1Host:api.company-mood.comContent-Type:application/jsonAccept:application/vnd.company-mood-v2+jsonX-App-Token:27f50875-9a43-4d6c-a376-6968f09858db{"data":{"type":"oauth","attributes":{"id_token":"INSERT ID TOKEN HERE"}}}
You can create a new oauth session and get the auth_token and other important informations
about the just logged in user by sending a id_token to this endpoint.
The returned role can be “admin”, “supervisor”, “employee” or “department_manager”.
You can create a new oauth session and get the auth_token and other important informations
about the just logged in user by sending a id_token to this endpoint.
The returned role can be “admin”, “supervisor”, “employee” or “department_manager”.
POST Attributes
We support those 2 token types for azure authentication via oauth2.
Make sure to only send one of them rather than both in the same request.
Will the user receive push notifications for mood reviews on mobile phones?
mood_creation_reminder_push_notification_active
Will the user receive push notifications to remind him to answer the review question on mobile phone?
weekly_status_notification_active
Will the user receive a weekly status report per mail? (Attribute is not present for users without a report role)
Sign in via apple
POST/oauth/appleHTTP/1.1Host:api.company-mood.comContent-Type:application/jsonAccept:application/vnd.company-mood-v2+jsonX-App-Token:27f50875-9a43-4d6c-a376-6968f09858db{"data":{"type":"oauth","attributes":{"authorization_code":"authorizationCode from apple-service","authorized_scopes":"authorizedScopes from apple-service","email":"email from apple-service","full_name":"fullName from apple-service","identity_token":"identityToken from apple-service","real_user_status":"realUserStatus from apple-service","state":"state from apple-service","user":"user from apple-service"}}}
HTTP/1.1200OKContent-Type:application/json{"meta":{"from":"2015-01-30","to":"2015-04-30","last_weeks_mood_id":"e96afc28-f27e-49b9-9f27-94dd3e2a296b"},"data":[{"id":"094822c8-d81f-4639-8197-9a586f10edcd","type":"moods","attributes":{"rating":100,"calendar_week":46,"year":2015,"reason":"It was pretty noisy this week","reasonings":[],"feeling":"happy","department_id":"f7559f2a-8f1c-461e-8a9b-7efea5564edb","created_at":"2015-11-21T05:59:42.517Z"}},{"id":"e96afc28-f27e-49b9-9f27-94dd3e2a296b","type":"moods","attributes":{"rating":75,"calendar_week":47,"year":2015,"reason":"Got a new place in the basement! :)","reasonings":[{"custom_tag_id":"f7559f2a-8f1c-461e-8a9b-7efea5564edb","feeling":"happy","reason":"The reason for happy custom tag"}],"feeling":"satisfied","department_id":"a9767fd1-a187-40e2-954c-872cebff5e70","created_at":"2015-11-18T19:18:42.517Z"}}]}
Request the moods for the logged in user.
Possibility to filter the collection by from, to, all_in_company
and deparment_idparameters.
GET META Attributes
Paramteter
Description
from
optional
Date to limit the moods results (in ISO8601)
to
optional
Date to limit the moods results (in ISO8601)
all_in_company
optional
Return all moods of that company (true or false) - only works for company admins
department_id
optional
Return all moods of that department (true or false) - only works for company admins
device_uid
optional
If the user is authenticated by a QrCode, you can use the device_uid to retrieve only the devices moods
Response META Attributes
Paramteter
Description
from
Date to limit the moods results (in ISO8601)
to
Date to limit the moods results (in ISO8601)
last_weeks_mood_id
ID of the last weeks mood for given user (can be empty, means no mood given)
Response Attributes
Paramteter
Description
rating
Rating as a number between 0 - 100
calendar_week
Calendar week of the mood
year
Year of the mood
reason
Optional given reason
reasonings
list of reasonings as an array
reasonings[custom_tag_id]
ID of the custom tag for the reasoning
reasonings[feeling]
feeling for the reasoning
reasonings[reason]
reason for the reasoning as a string
feeling
Feeling of the mood (happy, satisfied, ok, unhappy, sad)
department_id
The moods department id
created_at
Date of the mood creation (in ISO8601)
Create a new mood for last week - For the authorized user
POST/moodsHTTP/1.1Host:api.company-mood.comContent-Type:application/jsonAccept:application/vnd.company-mood-v2+jsonAuthorization:Bearer 795665b4-53da-468c-a0d7-ab2d82e58406X-App-Token:27f50875-9a43-4d6c-a376-6968f09858db{"data":{"type":"moods","attributes":{"feeling":"happy","reason":"Got a new place in the basement! :)","tag_list":"Management","reasonings":[{"custom_tag_id":"f7559f2a-8f1c-461e-8a9b-7efea5564edb","feeling":"happy","reason":"The reason for happy custom tag"}]}}}
HTTP/1.1201CREATEDContent-Type:application/json{"data":{"id":"e96afc28-f27e-49b9-9f27-94dd3e2a296b","type":"moods","attributes":{"rating":100,"calendar_week":25,"year":2015,"reason":"Got a new place in the basement! :)","reasonings":[{"custom_tag_id":"f7559f2a-8f1c-461e-8a9b-7efea5564edb","feeling":"happy","reason":"The reason for happy custom tag"}],"feeling":"happy","department_id":"a9767fd1-a187-40e2-954c-872cebff5e70","created_at":"2015-06-25T11:18:42.517Z"}}}
Creates the mood for the latest calendar week.
You MUST provide a reason or at least one tag in the tag_list parameter.
POST Attributes
Parameter
Description
feeling
required
Feeling of the mood can be (“sad”, “unhappy”, “ok”, “satisfied”, “happy”) - in rating it’s 0, 25, 50, 75, 100
reason
optional
Text reason for the mood
reasonings
optional
list of reasonings as an array
reasonings[custom_tag_id]
required
ID of the custom tag for the reasoning
reasonings[feeling]
required
feeling for the reasoning
reasonings[reason]
optional
reason for the reasoning as a string
device_uid
optional
DeviceUid of the device - only send this if the user is authenticated via QrCode
Response Attributes
Paramteter
Description
rating
Rating as a number between 0 - 100
calendar_week
Calendar week of the mood
year
Year of the mood
reason
Optional given reason
reasonings
list of reasonings as an array
reasonings[custom_tag_id]
ID of the custom tag for the reasoning
reasonings[feeling]
feeling for the reasoning
reasonings[reason]
reason for the reasoning as a string
feeling
Feeling of the mood (happy, satisfied, ok, unhappy, sad)
department_id
The moods department id
created_at
Date of the mood creation (in ISO8601)
Create a new mood for last week - For a terminal (no user get assigned)
POST/moodsHTTP/1.1Host:api.company-mood.comContent-Type:application/jsonAccept:application/vnd.company-mood-v2+jsonAuthorization:Bearer 795665b4-53da-468c-a0d7-ab2d82e58406X-App-Token:27f50875-9a43-4d6c-a376-6968f09858db{"data":{"type":"moods","attributes":{"feeling":"happy","reason":"Got a new place in the basement! :)","reasonings":[{"custom_tag_id":"f7559f2a-8f1c-461e-8a9b-7efea5564edb","feeling":"happy","reason":"The reason for happy custom tag"}],"terminal_spot_id":"0f4d29f7-34e0-4ce9-b985-a90cccbd9f86","department_id":"f53ac2a2-2917-4b4a-84ac-8874f406dc97"}}}
HTTP/1.1201CREATEDContent-Type:application/json{"data":{"id":"e96afc28-f27e-49b9-9f27-94dd3e2a296b","type":"moods","attributes":{"rating":100,"calendar_week":25,"year":2015,"reason":"Got a new place in the basement! :)","reasonings":[{"custom_tag_id":"f7559f2a-8f1c-461e-8a9b-7efea5564edb","feeling":"happy","reason":"The reason for happy custom tag"}],"feeling":"happy","department_id":"a9767fd1-a187-40e2-954c-872cebff5e70","created_at":"2015-06-25T11:18:42.517Z"}}}
Creates the mood for the latest calendar week.
You MUST provide a reason or at least one tag in the tag_list parameter.
POST Attributes
Parameter
Description
feeling
required
Feeling of the mood can be (“sad”, “unhappy”, “ok”, “satisfied”, “happy”) - in rating it’s 0, 25, 50, 75, 100
reason
required
Text reason for the mood
reasonings
optional
list of reasonings as an array
reasonings[custom_tag_id]
required
ID of the custom tag for the reasoning
reasonings[feeling]
required
feeling for the reasoning
reasonings[reason]
optional
reason for the reasoning as a string
terminal_spot_id
required
ID of the terminal spot for which you want to track the mood
department_id
required
ID of the department for which you want to track the terminals mood (need to be assigned to the particular terminal)
Response Attributes
Paramteter
Description
rating
Rating as a number between 0 - 100
calendar_week
Calendar week of the mood
year
Year of the mood
reason
Optional given reason
reasonings
list of reasonings as an array
reasonings[custom_tag_id]
ID of the custom tag for the reasoning
reasonings[feeling]
feeling for the reasoning
reasonings[reason]
reason for the reasoning as a string
feeling
Feeling of the mood (happy, satisfied, ok, unhappy, sad)
department_id
The moods department id
created_at
Date of the mood creation (in ISO8601)
Update a mood
PUT/moods/{mood_id}HTTP/1.1Host:api.company-mood.comContent-Type:application/jsonAccept:application/vnd.company-mood-v2+jsonAuthorization:Bearer 795665b4-53da-468c-a0d7-ab2d82e58406X-App-Token:27f50875-9a43-4d6c-a376-6968f09858db{"data":{"type":"moods","attributes":{"feeling":"satisfied","reason":"Got a new place in the basement! :)","reasonings":[{"custom_tag_id":"f7559f2a-8f1c-461e-8a9b-7efea5564edb","feeling":"happy","reason":"The reason for happy custom tag"}]}}}
HTTP/1.1200OKContent-Type:application/json{"data":{"id":"e96afc28-f27e-49b9-9f27-94dd3e2a296b","type":"moods","attributes":{"rating":75,"calendar_week":25,"year":2015,"reason":"Got a new place in the basement! :)","reasonings":[{"custom_tag_id":"f7559f2a-8f1c-461e-8a9b-7efea5564edb","feeling":"happy","reason":"The reason for happy custom tag"}],"feeling":"satisfied","department_id":"a9767fd1-a187-40e2-954c-872cebff5e70","created_at":"2015-06-25T11:18:42.517Z"}}}
Update a specific mood (by mood_id in the URI)
You can only update the mood for last calendar week and if its creation
(created_at) is not older than 24h.
You MUST provide a reason or at least one tag in the tag_list parameter.
PUT Attributes
Parameter
Description
feeling
required
Feeling of the mood can be (“sad”, “unhappy”, “ok”, “satisfied”, “happy”) - in rating it’s 0, 25, 50, 75, 100
reason
required
Text reason for the mood
reasonings
optional
list of reasonings as an array
reasonings[custom_tag_id]
required
ID of the custom tag for the reasoning
reasonings[feeling]
required
feeling for the reasoning
reasonings[reason]
optional
reason for the reasoning as a string
Response Attributes
Paramteter
Description
rating
Rating as a number between 0 - 100
calendar_week
Calendar week of the mood
year
Year of the mood
reason
Optional given reason
reasonings
list of reasonings as an array
reasonings[custom_tag_id]
ID of the custom tag for the reasoning
reasonings[feeling]
feeling for the reasoning
reasonings[reason]
reason for the reasoning as a string
feeling
Feeling of the mood (happy, satisfied, ok, unhappy, sad)
To start a reset password process you have to send a POST request with the user email
address to this endpoint. If the request was successful, you’ll receive an email
with a password reset link.
This endpoint does not require authentication with auth_token.
HTTP/1.1200OKContent-Type:application/json{"data":[{"id":"f7559f2a-8f1c-461e-8a9b-7efea5564edb","type":"public-announcements","attributes":{"creator_name":"Jovanni Williamson","content":"Awesome public announcement","task_id":"a9767fd1-a187-40e2-954c-872cebff5e70","own_reaction":"up","reaction_counts":{"up":15,"down":2},"created_at":"2018-06-25T11:18:42.517Z"}},{"id":"f7559f2a-8f1c-461e-8a9b-7efea5564edb","type":"public-announcements","attributes":{"creator_name":"Sammy Nonetti","content":"We created a survey for our upcoming team event. Please participate.","task_id":"e96afc28-f27e-49b9-9f27-94dd3e2a296b","own_reaction":null,"reaction_counts":{"up":8,"down":1},"created_at":"2018-05-25T19:12:32.212Z"}}]}
Get all public announcements which are accessible by the current user.
Response Attributes
Paramteter
Description
id
ID of the public announcement.
creator_name
Name of announcement creator.
content
Content of the public announcement.
task_id
ID of the associated Task.
own_reaction
The reaction of the current user. Can be “up”, “down” or null.
reaction_counts
An Object with details for “up” and “down” reactions.
reaction_counts[up]
Amount of up votes.
reaction_counts[down]
Amount of down votes.
created_at
Date of the public announcement creation (in ISO8601)
HTTP/1.1201CREATEDContent-Type:application/json{"data":{"id":"f7559f2a-8f1c-461e-8a9b-7efea5564edb","type":"public-announcements","attributes":{"creator_name":"Jovanni Williamson","content":"Awesome public announcement","task_id":"a9767fd1-a187-40e2-954c-872cebff5e70","own_reaction":"down","reaction_counts":{"up":14,"down":3},"created_at":"2018-06-25T11:18:42.517Z"}}}
React on public announcements with an “up” or “down” vote.
POST attributes
Paramteter
Description
reaction
The reaction key. Can be “up” or “down”.
Response Attributes
Paramteter
Description
id
ID of the public announcement.
creator_name
Name of announcement creator.
content
Content of the public announcement.
task_id
ID of the associated Task.
own_reaction
The reaction of the current user. Can be “up”, “down” or null.
reaction_counts
An Object with details for “up” and “down” reactions.
reaction_counts[up]
Amount of up votes.
reaction_counts[down]
Amount of down votes.
created_at
Date of the public announcement creation (in ISO8601)
Reasonings (comments from all sources like moods, reasonings, suggestions)
HTTP/1.1200OKContent-Type:application/json{"meta":{"from":"2020-04-01","to":"2020-05-31","origin_type":"Company","origin_id":"e96afc28-f27e-49b9-9f27-94dd3e2a296b","reasonings_feeling":"happy","reasonings_custom_tag_id":null,"with_reason_only":true},"data":[{"id":"1763109913022098","type":"reasoning-1583247555","attributes":{"username":"Anonym","email":null,"department_string":null,"custom_tags":["Health"],"custom_tag_label":"Health","custom_tag_id":"5c8d26ee-3a0e-3c55-8281-7fu67ed069c5","feeling_key":"happy","rating":100,"period":"KW 21/20","comment":"Finally great again... Cured that arrow to the knee! :)","answered":false,"answers_count":0,"answers":[],"chat_allowed":false,"additional_export_information":null}}]}
Request the reasonings for the given meta filters.
GET META Attributes
Paramteter
Description
origin_type
required
Class of the reasoning origin. [Company, Department]
origin_id
required
UUID of the requested origin.
from
optional
Date to limit the moods results (in ISO8601)
to
optional
Date to limit the moods results (in ISO8601)
reasonings_feeling
optional
Filter reasonings for a specific feeling key [sad, unhappy, ok, satisfied, happy, positive, negative]
reasonings_custom_tag_id
optional
Filter for a specific custom_tag
with_reason_only
optional
Return only reasonings with an existing comment
Response META Attributes
Paramteter
Description
origin_type
required
Class of the reasoning origin. [Company, Department]
origin_id
required
UUID of the requested origin.
from
optional
Date to limit the moods results (in ISO8601)
to
optional
Date to limit the moods results (in ISO8601)
reasonings_feeling
optional
Filter reasonings for a specific feeling key [sad, unhappy, ok, satisfied, happy, positive, negative]
Creates a suggestion for the current user with the given details.
You MUST provide a feeling, content and a custom_tag.
The suggestion will be anonymous by default if you don’t provide
a not_anonymous parameter. If your company is setup to not allow anonymous suggestions it will be always true.
POST Attributes
Paramteter
Description
content
required
The suggestion content.
feeling
required
Feeling of the suggestion can be (“sad”, “unhappy”, “ok”, “satisfied”, “happy”).
custom_tag_id
required
ID of the custom tag for the suggestion.
not_anonymous
optional
Create not anonymous suggestion. True or false. false by default if not given. Always true if company is setup to not allow anonymous suggestions.
terminal_spot_id
optional
ID of the terminal spot for the suggestion.
Response Attributes
Paramteter
Description
content
The suggestion content
feeling
Feeling of the suggestion can be (“sad”, “unhappy”, “ok”, “satisfied”, “happy”)
custom_tag_id
ID of the custom tag for the suggestion
not_anonymous
Boolean value. Displays if suggestion is anonymous or not.
terminal_spot_id
ID of the terminal spot for the suggestion.
created_at
Date of the suggestion creation (in ISO8601)
Tasks
Get all tasks for current user
Get all tasks for the current user which are not archived.
Role of the user (admin, supervisor, department_manager or employee)
company_id
ID of the company, the user belongs to. null if the user does’t belong to a company, yet.
department_id
ID of the department, the user belongs to. null if the user doesn’t belong to a department.
disable_all_emails
Are all emails disabled for this user? - Only changeable through API from ADMIN
external_uid
External UID - After setting, it can also be used as ID in Post /users and PUT /users/:id
personnel_number
The personnel number of the employee
faculty
The users facutly
job_title
The users job title
manager_name
The users managers name (or email)
region_name
The users region
location_name
The users location
Create a new user
This will create a user in your company which is directly able to use oauth or use
password reset to set a password.
If you want to invite a user to your company with invitation email and
invitation completion form (where the user set the password etc) you
need to use the users invite endpoint (see below)
Will the user receive push notifications for mood reviews on mobile phones?
mood_creation_reminder_push_notification_active
Will the user receive push notifications to remind him to answer the review question on mobile phone?
weekly_status_notification_active
Will the user receive a weekly status report per mail? (Attribute is not present for users without a report role)
disable_all_emails
Are all emails disabled for this user? - Only changeable through API from ADMIN
external_uid
External UID - After setting, it can also be used as ID in Post /users and PUT /users/:id
personnel_number
The personnel number of the employee
faculty
The users facutly
job_title
The users job title
manager_name
The users managers name (or email)
region_name
The users region
location_name
The users location
Invite a user
This will invite a user to your company account.
The user will receive an email and can complete the registration with firstname, lastname and password setting there.
If you want to create direct usable user accounts with fix passwords, name, email etc please use the users create endpoint (see above)
This endpoint returns a set of available widgets for the current user.
The set of returned widgets depends on the role of the current user and the optional
given type filter.
To get a list with all widgets just request /widgets. If you want to get a list of widgets for the dashboard just request /widgets
with type filter.
You can use the returned id’s to request the data for specific widgets with a call to /widgets/:id.
This endpoint returns the custom tag widget (Top X custom tags) data for the current
user company and the current tracking period. The response doesn’t include custom tags or
feelings where no moods has been given in the current tracking period.
The custom_tag_details attribute will be an empty Array if no custom tag has any moods.
Response Attributes
Parameter
Description
total_moods_count
Total amount of moods in current tracking period for current user company.
total_reasonings_count
Total amount of reasonings in current tracking period for current user company.
custom_tag_details
An Array of objects with reasoning details for each custom tag.
custom_tag_details[custom_tag_id]
ID of the custom tag.
custom_tag_details[reasonings_count]
Amount of given reasonings for the custom tag.
custom_tag_details[feeling_details]
An Array of objects with details for each feeling where moods exist.
custom_tag_details[feeling_details][name]
The identifier of the feeling.
custom_tag_details[feeling_details][percent]
Percentage of total given moods for the current custom tag.
This endpoint returns the custom tag widget (Top X custom tags) data for the current
user department and the current tracking period. The response doesn’t include custom tags or
feelings where no moods has been given in the current tracking period.
Response Attributes
Parameter
Description
total_moods_count
Total amount of moods in current tracking period for current user department.
total_reasonings_count
Total amount of reasonings in current tracking period for current user department.
custom_tag_details
An Array of objects with mood details for each custom tag.
custom_tag_details[custom_tag_id]
ID of the custom tag.
custom_tag_details[reasonings_count]
Amount of given reasonings for the custom tag.
custom_tag_details[feeling_details]
An Array of objects with details for each feeling where reasonings exist.
custom_tag_details[feeling_details][name]
The identifier of the feeling.
custom_tag_details[feeling_details][percent]
Percentage of total given reasonings for the current custom tag.
