users

Find users

Retrieves a list of all resources from the service.

get/users

Request

Base URL: https://api.hoorayhr.io
URL: https://api.hoorayhr.io/users
Auth: API key in header authorization

Query parameters

includeExtraFields'true' | '1' | 'false' | '0'

Include extra fields in the response. Extra fields without a value for this user will be null.

Response

success

idinteger

Unique id of the user.

entityIdinteger nullable

Unique id of the entity the user belongs to.

isDemoDataboolean

Indicates if the user is demo data. Demo data can be optionally created during a company's trial period. After the trial period is over, demo data is removed.

emailstring email required

E-mail address of the user.

statusinteger

Status of the user. Users added through the API always get status 'NOT INVITED'. Inviting users can be done by admin users in the application. 0 = NOT INVITED, 1 = INVITED, 2 = ACTIVATED, 3 = ARCHIVED.

isAdmininteger

Tiny-int indicating if the user has admin rights. 0 = NON-ADMIN, 1 = ADMIN.

isHiddenboolean

Hidden users are not visible in the application to non-admins.

timezonestring

Timezone of the user.

teamsstring nullable

Stringified array containing the team-ids the user is part of.

companyStartDatestring date nullable

Start of employment date

companyEndDatestring date nullable

End of employment date

seniorityDatestring date nullable

Historical start date of employment

initialsstring nullable

Initials of the user.

firstNamestring nullable

First name of the user.

insertionstring nullable

Last name affix of the user.

lastNamestring nullable

Last name of the user.

insertionPartnerstring nullable

Last name affix of the user's partner.

lastNamePartnerstring nullable

Last name of the user's partner.

lastNameUsage'OWN' | 'PARTNER' | 'OWN_PARTNER' | 'PARTNER_OWN'

The way a user’s last name is displayed.

nickNamestring nullable

Nickname of the user.

formattedLastNamestring nullable

Generated formatted last name combining own and partner sides based on lastNameUsage.

displayNamestring nullable

Generated full display name of the user based on name fields and lastNameUsage.

birthdatestring date nullable

Birthdate of the user.

birthPlacestring nullable

Birth place of the user.

birthCountrystring nullable

Birth country of the user. A full list of country codes can be found here.

gender'UNKNOWN' | 'MALE' | 'FEMALE' | 'OTHER' | 'NOT_SPECIFIED'

Gender of the user.

nationalitystring

Nationality of the user. A full list of nationality codes can be found here.

Civil status of the user.

jobTitlestring nullable

Job title of the user.

biographystring long-text nullable

Biography of the user.

phonestring nullable

Phone number of the user.

emailPrivatestring email nullable

Private e-mail address of the user.

addressStreetstring nullable

Address street of the user.

addressNumberstring nullable

Address number of the user.

addressAdditionstring nullable

Address addition of the user.

zipcodestring nullable

Zipcode of the user.

citystring nullable

City of the user.

countrystring nullable

The current country of the user. A full list of country codes can be found here.

bankAccountNumberstring nullable

Bank account number is only visible for the user and admins.

bankAccountNumberOnBehalfOfstring nullable

Bank account number on behalf of is only visible for the user and admins.

citizenServiceNumberstring nullable

Citizen service number is only visible for the user and admins.

employeeNumberstring nullable

Employee number of the user.

emergencyNamestring nullable

Emergency contact name

emergencyRelationstring nullable

Emergency contact relation

emergencyPersonalPhonestring nullable

Emergency contact personal phone number

emergencyWorkPhonestring nullable

Emergency contact work phone number

locale'nl' | 'en' | 'de'

The user's language preference

invitedByUserIdinteger

Unique user id of the inviter.

invitedAtstring date

inviteAcceptedAtstring date

inviteRemindedAtstring date

onBoardedAtstring date

Date the user completed the onboarding wizard after the first login.

currencystring

A ISO 4217 string indicating the user's currency. This is used as the default for things like expense claims and salaries. It'll be set based on the default currency of the company if it isn't set.

travelAllowanceCurrencystring

A ISO 4217 string indicating the user's currency. This is used specifically as the default for travel expenses. It'll be set based on the default travel allowance currency of the company if it isn't set.

travelAllowancenumber double

The amount of travel allowance a user gets per kilometer by default for travel expenses. Will be set based on the default travel allowance of the company if it isn't set.

createdAtstring date-time

Creation date of the user

updatedAtstring date-time

Last updated date of the user

Example response

[
  {
    "id": 1,
    "entityId": 1,
    "email": "user@domain.nl",
    "status": 2,
    "timezone": "Europe/Amsterdam",
    "teams": "[1, 2, 3]",
    "companyStartDate": "2021-01-30",
    "companyEndDate": "2021-01-30",
    "seniorityDate": "2017-01-30",
    "initials": "John",
    "firstName": "John",
    "insertion": "von",
    "lastName": "Doe",
    "insertionPartner": "of",
    "lastNamePartner": "Smith",
    "lastNameUsage": "PARTNER_OWN",
    "nickName": "Johny",
    "formattedLastName": "de Vries - Boompjes",
    "displayName": "John Doe",
    "birthdate": "2021-01-30",
    "birthPlace": "Amsterdam",
    "birthCountry": "NL",
    "gender": "FEMALE",
    "nationality": "NL",
    "civilStatus": "UNMARRIED",
    "jobTitle": "Developer",
    "biography": "Hello! I am John Doe.",
    "phone": "0655203256",
    "emailPrivate": "user@domain.nl",
    "addressStreet": "John Doe Street",
    "addressNumber": "102",
    "addressAddition": "BIS",
    "zipcode": "3411 XX",
    "city": "Amsterdam",
    "country": "NL",
    "emergencyName": "Darlene Doe",
    "emergencyRelation": "Mother",
    "emergencyPersonalPhone": "0655203256",
    "emergencyWorkPhone": "0655203256",
    "locale": "nl",
    "invitedByUserId": 100,
    "invitedAt": "2021-01-30",
    "inviteAcceptedAt": "2021-01-30",
    "inviteRemindedAt": "2021-01-30",
    "onBoardedAt": "2021-01-30",
    "currency": "EUR",
    "travelAllowanceCurrency": "EUR",
    "travelAllowance": 0.23,
    "createdAt": "2022-02-15T14:01:17.516Z",
    "updatedAt": "2022-02-23T14:01:17.516Z",
    "extraFields": [
      {
        "fieldName": "T-shirt size",
        "value": "XL"
      }
    ]
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.