Human resource APIs
Employee details for the provided identifier
| HTTP method | GET |
| URI | https://api.rambase.net/human-resources/employees/{employeeId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {employeeId} |
Employee identifier
Integer, minimum 100 |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 200 |
| API resource identifier | 413, version 31 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
| $showDomainDescriptions Boolean, optional | Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false. |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
| $access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
| $db String, optional | Set the database/company for the request |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
| $select String, optional | Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information. |
| $showCustomFields Boolean, optional | Set to "true" to include custom fields. Default value is false. |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
EmployeeId
Employee identifier
>{Integer}</EmployeeId>LastName
Last name of employee
>{String}</LastName>FirstName
First name of employee
>{String}</FirstName>JobTitle
Job title of employee. Ex. Sales manager
>{String}</JobTitle>Email address of the employee
>{String}</Email>WorkExperienceSummary
The employee's summary of their whole work experience
>{String}</WorkExperienceSummary>TotalVacationDays
Total eligible vacation from settings
>{Integer}</TotalVacationDays>ExternalSalaryId
Salary indentifier
>{String}</ExternalSalaryId>ApprovalNote
Approval note for the employee
>{String}</ApprovalNote>CountryCode
Country code of the employee
>{String}</CountryCode>CompanyId
Company identifier
>{Integer}</CompanyId>Name
Name of company
>{String}</Name>Database
Abbreviation/code to identify the company
>{String}</Database>CompanyLink
Company reference
>{String}</CompanyLink>DepartmentId
Department identifier
>{Integer}</DepartmentId>Name
Name of department
>{String}</Name>DepartmentLink
Finance department reference
>{String}</DepartmentLink>Superior
Superior of the employee
>EmployeeId
Employee identifier
>{Integer}</EmployeeId>LastName
Last name of employee
>{String}</LastName>FirstName
First name of employee
>{String}</FirstName>EmployeeLink
Employee reference
>{String}</EmployeeLink>LocationId
Location identifier
>{Integer}</LocationId>Name
Name of warehouse location
>{String}</Name>ShortName
Unique abbreviation/short name of the location
>{String}</ShortName>LocationLink
Location reference
>{String}</LocationLink>LocationId
Location identifier
>{Integer}</LocationId>Name
Name of warehouse location
>{String}</Name>ShortName
Unique abbreviation/short name of the location
>{String}</ShortName>LocationLink
Location reference
>{String}</LocationLink>LaborGroupId
Labor group identifier
>{Integer}</LaborGroupId>Name
Name of labor group
>{String}</Name>LaborGroupLink
Labor group reference
>{String}</LaborGroupLink>EmployeeId
Employee identifier
": "{Integer}",Status
Status of employee
Possible domain values can be found here
": "{Integer}",LastName
Last name of employee
": "{String}",FirstName
First name of employee
": "{String}",Gender
Gender of the employee
Possible domain values can be found here
": "{String}",JobTitle
Job title of employee. Ex. Sales manager
": "{String}",Email address of the employee
": "{String}",WorkExperienceSummary
The employee's summary of their whole work experience
": "{String}",TotalVacationDays
Total eligible vacation from settings
": "{Integer}",ExternalSalaryId
Salary indentifier
": "{String}",ApprovalNote
Approval note for the employee
": "{String}"CountryCode
Country code of the employee
": "{String}"CompanyId
Company identifier
": "{Integer}",Name
Name of company
": "{String}",Database
Abbreviation/code to identify the company
": "{String}",CompanyLink
Company reference
": "{String}"DepartmentId
Department identifier
": "{Integer}",Name
Name of department
": "{String}",DepartmentLink
Finance department reference
": "{String}"Superior
Superior of the employee
": {EmployeeId
Employee identifier
": "{Integer}",LastName
Last name of employee
": "{String}",FirstName
First name of employee
": "{String}",EmployeeLink
Employee reference
": "{String}"LocationId
Location identifier
": "{Integer}",Name
Name of warehouse location
": "{String}",ShortName
Unique abbreviation/short name of the location
": "{String}",LocationLink
Location reference
": "{String}"LocationId
Location identifier
": "{Integer}",Name
Name of warehouse location
": "{String}",ShortName
Unique abbreviation/short name of the location
": "{String}",LocationLink
Location reference
": "{String}"LaborGroupId
Labor group identifier
": "{Integer}",Name
Name of labor group
": "{String}",LaborGroupLink
Labor group reference
": "{String}"
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
| Error 101013 HTTP 404 | Sub-module not found |
| Error 102018 HTTP 403 | You need permission {0}. Duties with this permission: {1} |
| Error 100086 HTTP 403 | You have only access to the employees in your Company group |