| \n\nParameter\n\n | \n\nDescription\n\n |
|---|---|
| \n\nemployee\\_identifier\n\n | \n\nUnique identifier of an employee. The calling system generates this value and can be in whatever format is consistent with their system. To obtain this value, first call the endpoint using the **updated\\_after** parameter.**Note:** This parameter is mutually exclusive with the **updated\\_after** parameter. This parameter defines a unique employee, whereas **updated\\_after** returns a group of employees created/updated after a specified date.\n\nData type: String\n\n |
| \n\nsysparm\\_limit\n\n | \n\nMaximum number of records to return. For requests that exceed this number of records, use the **sysparm\\_offset** parameter to paginate record retrieval. Data type: Number\n\nDefault: 1000\n\n |
| \n\nsysparm\\_offset\n\n | \n\nStarting record index for which to begin retrieving records. Use this value to paginate record retrieval. This functionality enables the retrieval of all records, regardless of the number of records, in small manageable chunks. For example, the first time you call this endpoint, **sysparm\\_offset** is set to \"0\". To simply page through all available records, use `sysparm_offset=sysparm_offset+sysparm_limit`, until you reach the end of all records.\n\n |
| \n\nupdated\\_after\n\n | \n\nDate to use to determine the employee data to return. All United States-based employees \\(work or home\\) that were added to your instance, or whose information was updated on or after this date, are included in the return results.**Note:** This parameter is mutually exclusive with the **employee\\_identifier** parameter.\n\nData type: String\n\nFormat: YYYY-MM-DD HH:MM:SS or YYYY-MM-DD \\(time defaults to 00:00:00\\)\n\n |
| \n\nHeader\n\n | \n\nDescription\n\n |
|---|---|
| \n\nAccept\n\n | \n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n |
| \n\nHeader\n\n | \n\nDescription\n\n |
|---|---|
| \n\nNext-Page\n\n | \n\nFlag that indicates whether there is additional data to obtain in a subsequent call. For example, if there are a total of 120 employee records that match the search criteria, and sysparm\\_limit is set to 100, then **Next-Page** is true. If no additional results are available, **Next-Page** is false.Valid values:\n\n- true: Additional data is available, another call must be made to obtain the next chunk of data.\n- false: No additional data.\n\n |
| \n\nElement\n\n | \n\nDescription\n\n |
|---|---|
| \n\nBirthDate\n\n | \n\nEmployee's birth date.Data type: String\n\n |
| \n\nCompany\n\n | \n\nCompany name.Data type: String\n\n |
| \n\nEmail\n\n | \n\nEmployee's email address.Data type: String\n\n |
| \n\nEmployeeIdentifier\n\n | \n\nUnique employee identifier.Data type: String\n\n |
| \n\nFirstName\n\n | \n\nEmployee's first name.Data type: String\n\n |
| \n\nHireDate\n\n | \n\nDate on which the employee was hired.Data type: String\n\n |
| \n\nLastName\n\n | \n\nEmployee's last name.Data type: String\n\n |
| \n\nMiddleName\n\n | \n\nEmployee's middle name.Data type: String\n\n |
| \n\nReHire\n\n | \n\nFor future use.Data type: String\n\n |
| \n\nResidenceAddress\n\n | \n\nEmployee's home street address.Data type: String\n\n |
| \n\nResidenceCity\n\n | \n\nEmployee's home city.Data type: String\n\n |
| \n\nResidenceCountry\n\n | \n\nEmployee's home country.Data type: String\n\n |
| \n\nResidencePostalCode\n\n | \n\nEmployee's home zip code.Data type: String\n\n |
| \n\nResidenceState\n\n | \n\nEmployee's home state.Data type: String\n\n |
| \n\nSuffix\n\n | \n\nEmployee's suffix, such as Mr., Mrs., or Dr.Data type: String\n\n |
| \n\nWorkAddress\n\n | \n\nEmployee's work street address.Data type: String\n\n |
| \n\nWorkCity\n\n | \n\nEmployee's work cityData type: String\n\n |
| \n\nWorkCountry\n\n | \n\nEmployee's work country.Data type: String\n\n |
| \n\nWorkPostalCode\n\n | \n\nEmployee's work zip code.Data type: String\n\n |
| \n\nWorkState\n\n | \n\nEmployee's work state.Data type: String\n\n |