--- title: "Get user" method: GET path: "/users/{id}" tags: ["users"] --- # Get user `GET /users/{id}` ## Request - Base URL: `https://api.hoorayhr.io` - URL: `https://api.hoorayhr.io/users/{id}` - Auth: API key in header `authorization` Retrieves a single resource with the given id from the service. ## Path parameters - `id` integer, required ## Response `200` success - Users - `id` integer: Unique id of the user. - `entityId` integer, nullable: Unique id of the entity the user belongs to. - `isDemoData` boolean: 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. - `email` string, email, required: E-mail address of the user. - `status` integer: 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. - `isAdmin` integer: Tiny-int indicating if the user has admin rights. 0 = NON-ADMIN, 1 = ADMIN. - `isHidden` boolean: Hidden users are not visible in the application to non-admins. - `timezone` string: Timezone of the user. - `teams` string, nullable: Stringified array containing the team-ids the user is part of. - `companyStartDate` string, date, nullable: Start of employment date - `companyEndDate` string, date, nullable: End of employment date - `seniorityDate` string, date, nullable: Historical start date of employment - `initials` string, nullable: Initials of the user. - `firstName` string, nullable: First name of the user. - `insertion` string, nullable: Last name affix of the user. - `lastName` string, nullable: Last name of the user. - `insertionPartner` string, nullable: Last name affix of the user's partner. - `lastNamePartner` string, nullable: Last name of the user's partner. - `lastNameUsage` 'OWN' | 'PARTNER' | 'OWN_PARTNER' | 'PARTNER_OWN': The way a user’s last name is displayed. - `nickName` string, nullable: Nickname of the user. - `formattedLastName` string, nullable: Generated formatted last name combining own and partner sides based on lastNameUsage. - `displayName` string, nullable: Generated full display name of the user based on name fields and lastNameUsage. - `birthdate` string, date, nullable: Birthdate of the user. - `birthPlace` string, nullable: Birth place of the user. - `birthCountry` string, nullable: Birth country of the user. A full list of country codes can be found [here](https://helpcenter.hoorayhr.io/nl/articles/8052332-api-list-of-country-codes). - `gender` 'UNKNOWN' | 'MALE' | 'FEMALE' | 'OTHER' | 'NOT_SPECIFIED': Gender of the user. - `nationality` string: Nationality of the user. A full list of nationality codes can be found [here](https://helpcenter.hoorayhr.io/nl/articles/8052325-api-list-of-nationality-codes). - `civilStatus` 'UNKNOWN' | 'UNMARRIED' | 'MARRIED' | 'REGISTERED_PARTNERSHIP' | 'PERMANENTLY_DIVORCED' | 'WIDOWHOOD' | 'COHABITING' | 'DIVORCED' | 'PARTNERSHIP_ENDED' | 'ABANDONED_PARTNER': Civil status of the user. - `jobTitle` string, nullable: Job title of the user. - `biography` string, long-text, nullable: Biography of the user. - `phone` string, nullable: Phone number of the user. - `emailPrivate` string, email, nullable: Private e-mail address of the user. - `addressStreet` string, nullable: Address street of the user. - `addressNumber` string, nullable: Address number of the user. - `addressAddition` string, nullable: Address addition of the user. - `zipcode` string, nullable: Zipcode of the user. - `city` string, nullable: City of the user. - `country` string, nullable: The current country of the user. A full list of country codes can be found [here](https://helpcenter.hoorayhr.io/nl/articles/8052332-api-list-of-country-codes). - `bankAccountNumber` string, nullable: Bank account number is only visible for the user and admins. - `bankAccountNumberOnBehalfOf` string, nullable: Bank account number on behalf of is only visible for the user and admins. - `citizenServiceNumber` string, nullable: Citizen service number is only visible for the user and admins. - `employeeNumber` string, nullable: Employee number of the user. - `emergencyName` string, nullable: Emergency contact name - `emergencyRelation` string, nullable: Emergency contact relation - `emergencyPersonalPhone` string, nullable: Emergency contact personal phone number - `emergencyWorkPhone` string, nullable: Emergency contact work phone number - `locale` 'nl' | 'en' | 'de': The user's language preference - `invitedByUserId` integer: Unique user id of the inviter. - `invitedAt` string, date - `inviteAcceptedAt` string, date - `inviteRemindedAt` string, date - `onBoardedAt` string, date: Date the user completed the onboarding wizard after the first login. - `currency` string: A [ISO 4217](https://en.wikipedia.org/wiki/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. - `travelAllowanceCurrency` string: A [ISO 4217](https://en.wikipedia.org/wiki/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. - `travelAllowance` number, 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. - `createdAt` string, date-time: Creation date of the user - `updatedAt` string, date-time: Last updated date of the user - `extraFields` object[]: A list of the company's extra fields and their values for this user. **NOTE**: This field is only returned when the `includeExtraFields` query parameter is set to `true` or `1`. - `fieldName` string: Name of the extra field. - `value` union: Value of the extra field for this user. The type of this is based type of extra field (string, number, array of strings) - string - string, date - number - string[]: Array of values if the extra field is a select or multi-select field. ## Other responses - `401`: not authenticated - `404`: not found - `500`: general error --- [API](https://skmtc.dev/hoorayhr/apis/hoorayhr-api-documentation.md) · [All operations](https://skmtc.dev/hoorayhr/apis/hoorayhr-api-documentation/llms.txt) · [OpenAPI document](https://skmtc.dev/hoorayhr/apis/hoorayhr-api-documentation/revisions/3adcd47cd827?raw)