Resource

{
    "data": [
        {
            "access_groups": [
                {
                    "id": "integer",
                    "name": "string"
                }
            ],
            "activated_at": "string",
            "birthday": "string",
            "country": "string",
            "custom_attributes": {},
            "department_id": [
                "integer"
            ],
            "direct_manager_ids": [
                "integer"
            ],
            "email": "email",
            "employee_id": "string",
            "end_of_employment": "string",
            "first_name": "string",
            "gender": "string",
            "generic_role": "string",
            "id": "integer",
            "initials": "string",
            "language": "string",
            "last_name": "string",
            "legal": "string",
            "level": "integer",
            "location": "string",
            "mobile": "string",
            "personal_email": "email",
            "phone": "string",
            "salary_id": "integer",
            "skill_level": "string",
            "start_of_employment": "string",
            "sub_company": "string",
            "team_id": [
                "integer"
            ],
            "timezone": "string",
            "title": "string",
            "user_permission": "string",
            "username": "string"
        }
    ],
    "extended_message": "string",
    "message": "string",
    "status": "string",
    "status_code": "integer"
}

Properties

Name Example Description
data[]
data[].access_groups[]

IDs of the access groups that will be inherited by department members

data[].access_groups[].id 24

ID of access group

data[].access_groups[].name "No special access"

Name of access group

data[].activated_at "2018-12-14 14:36:38"

The time at which the user activated the eloomi account

data[].birthday "1980-12-14 00:00:00"

The users birthday

data[].country "Denmark"

Country of the user

data[].custom_attributes { "hair_color": "brown" }

Object containing extra data defined by the company

data[].department_id[] [ 1, 2 ]

The time at which the user activated the eloomi account

data[].direct_manager_ids[] [ 1, 2 ]

The IDs of the managers assigned directly to the user

data[].email "support@eloomi.com"

The users email

data[].employee_id "E0052"

Employees ID. Used to identify with other systems.

data[].end_of_employment "2018-12-14 00:00:00"

When did the user end employment

data[].first_name "Jane"

Users first name

data[].gender "F"

The user gender

Possible values are:

  • M
  • F
data[].generic_role "Architect"

A users generic role

data[].id 80085

eloomis internal id for the department

data[].initials "B. O."

The users initials

data[].language "en-US"

Language of the user. Format given in example.

data[].last_name "Doe"

Users last name

data[].legal "en-US"

Legal company

data[].level 5

Language of the user. Format given in example.

data[].location "Copenhagen"

Location of the user

data[].mobile

Mobile phone number of the user

data[].personal_email "my.private.mail@gmail.com"

The users personal email

data[].phone

Phone number of the user

data[].salary_id "en-US"

Language of the user. Format given in example.

data[].skill_level

Deprecated.

data[].start_of_employment "2010-12-14 00:00:00"

When did the user start employment

data[].sub_company

Deprecated

data[].team_id[] [ 1, 2 ]

The IDs of the teams the user is a part of

data[].timezone "Europe/Brussels"

The users timezone. Adheres to the tz database format (also knowns as the Olsen database)

data[].title "Accountant"

Title of the user

data[].user_permission "user"

The users permission level

Possible values are:

  • user
  • admin
data[].username "E0052"

The users username

extended_message

Text to help with debugging

message

Text to help with debugging

status "OK"

HTTP Status text

status_code 200

HTTP Status code