v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Users

Get User IDs by User Type

Returns a paged list of user IDs, for the specified user type, registered in the system.

get/v1/users/user-type/ids/{userType}/{page}/{pageSize}

Path parameters

pagestring required
userTypestring required

The name of the user type. Available options are Talent, Manager, HCM, or All.

pageSizestring required

Query parameters

includeInactivestring

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.

Response

A list of User IDs.

IntegerSchema[] required