Sign in

v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Users

Query Multiple HCM Users

Returns details about the specified HCM users.

post/v1/users/hcm/multi-query

Headers

RequestIdstring uuid

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Request body

IntegerSchema[] required

Response

A list of HCM users.

userIdinteger

The identifier for the user.

firstNamestring

The user's first name.

lastNamestring

The user's last name.

emailAddressstring

The user's email address.

homePhonestring

The user's home phone number.

workPhonestring

The user's work phone number.

mobilePhonestring

The user's mobile phone number.

faxPhonestring

The user's fax phone number.

officeNamestring

The name of the user's home office.

officeDivisionstring

The division of the user's home office.

officeRegionstring

The region of the user's home office.

isArchivedboolean

An indication of whether the user's record is archived or not.

createdDatestring date-time

The date when the user profile was created.

lastUpdatedDatestring date-time

The date of the most recent update to the user profile.

smsPhoneNumberstring

The phone number to which SMS messages should be sent.

smsForwardingNumberstring

The phone number to which SMS messages should be forwarded.

userTypestring

User type of the user

entityIdinteger

The ID of the entity associated with the user. When User Type = HCM, it is the ID of the user When User Type = Manager or Contractor, it is the ID of that entity

email2string

The second email of the user.

status'Inactive' | 'Active'
homeOfficeIdinteger

The identifier of the user's home office.

officeAccessinteger[]

A list of office IDs that the user has access to.

userGroupsinteger[]

A list of user group IDs to which the user belongs.

Example response

[
  {
    "address": {
      "addressGuid": "cb63d8fc-6d06-f011-87a7-a0595061251e",
      "street1": "123 Main St.",
      "street2": "Suite 250",
      "city": "Minneapolis",
      "state": "MN",
      "postalCode": "55435",
      "country": "US"
    },
    "homeOfficeId": 28925,
    "officeAccess": [
      28925,
      14587
    ],
    "userGroups": [
      12,
      34
    ]
  }
]