--- title: "List users" method: POST path: "/v3/users/list" tags: ["Users"] --- # List users `POST /v3/users/list` List users of a specific TMC or a company. ## Request body - union — List users request - object — TMC ID - `tmcId` EntityId, required — Identifier of an object - `id` string, uuid, required - `userStatusFilter` 'ACTIVE' | 'INACTIVE' | 'ALL' — Retrieve active, inactive, or all users. - `searchText` string — Query text to search users. The match would be case-insensitive. - `pagination` OffsetBasedPaginationRequestParams, required — Pagination parameters for requests. - `offset` integer — The starting index in the list from which results are returned. The value must be greater than or equal to 0. - `limit` integer — Maximum number of results to be fetched. - `filters` UserListFilter[] — Filters to refine the list of users returned. Users matching with any of the filters would be returned. - `legalEntityIds` EntityId[] — Filter by legal entity ids. - `id` string, uuid, required - `officeIds` EntityId[] — Filter by offices. - `id` string, uuid, required - `departmentIds` EntityId[] — Filter by department IDs. - `id` string, uuid, required - `costCenterIds` EntityId[] — Filter by cost center IDs. - `id` string, uuid, required - `userIds` EntityId[] — Filter by user IDs. - `id` string, uuid, required - `emails` string[] — Filter by user email IDs. - `externalIds` string[] — Filter by partner-assigned external identifiers for users. - `personas` Persona[] — Filter by user personas. - `roles` RoleType[] — Filter by user roles. - `designations` string[] — Filter by job titles or designations. - `tiers` Tier[] — Filter by tiers. - `region` string — Optional region filter to fetch user data from non US regions. - `sort` UserSort - `sortBy` 'NAME', required — The column on which the sorting should be applied. - `sortOrder` 'ASCENDING' | 'DESCENDING', required — Order of sorting ie ascending or descending. - object — Company ID - `companyId` EntityId, required — Identifier of an object - `id` string, uuid, required - `userStatusFilter` 'ACTIVE' | 'INACTIVE' | 'ALL' — Retrieve active, inactive, or all users. - `searchText` string — Query text to search users. The match would be case-insensitive. - `pagination` OffsetBasedPaginationRequestParams, required — Pagination parameters for requests. - `offset` integer — The starting index in the list from which results are returned. The value must be greater than or equal to 0. - `limit` integer — Maximum number of results to be fetched. - `filters` UserListFilter[] — Filters to refine the list of users returned. Users matching with any of the filters would be returned. - `legalEntityIds` EntityId[] — Filter by legal entity ids. - `id` string, uuid, required - `officeIds` EntityId[] — Filter by offices. - `id` string, uuid, required - `departmentIds` EntityId[] — Filter by department IDs. - `id` string, uuid, required - `costCenterIds` EntityId[] — Filter by cost center IDs. - `id` string, uuid, required - `userIds` EntityId[] — Filter by user IDs. - `id` string, uuid, required - `emails` string[] — Filter by user email IDs. - `externalIds` string[] — Filter by partner-assigned external identifiers for users. - `personas` Persona[] — Filter by user personas. - `roles` RoleType[] — Filter by user roles. - `designations` string[] — Filter by job titles or designations. - `tiers` Tier[] — Filter by tiers. - `region` string — Optional region filter to fetch user data from non US regions. - `sort` UserSort - `sortBy` 'NAME', required — The column on which the sorting should be applied. - `sortOrder` 'ASCENDING' | 'DESCENDING', required — Order of sorting ie ascending or descending. ## Response `200` OK - ListUsersV3Response — List users response - `users` UserDetail[] — Users matching the filters specified in the request. - `userId` UserId, required — User identifier - `id` string, uuid, required - `organization` Reference, required — Reference of an entity - `id` string, uuid, required - `name` string - `persona` 'UNKNOWN_PERSONA' | 'EMPLOYEE' | 'GUEST' | 'PERSONAL' | 'RELATIVE' | 'ADHOC', required — Persona of the user - `isActive` boolean, required — Whether user is active or not. - `externalId` string — External ID of the user. - `personalDetail` PersonalDetail, required — Personal details of the user - `name` Name — Full name containing first, middle, last (family) names, and suffix. - `family1` string, required — Last (family) name. - `family2` string - `given` string, required — First (given) name. - `middle` string — Middle name. - `suffix` 'NAME_SUFFIX_UNKNOWN' | 'SR' | 'JR' | 'MD' | 'PHD' | 'II' | 'III' | 'IV' | 'DO' | 'ATTY' | 'V' | 'VI' | 'ESQ' | 'DC' | 'DDS' | 'VM' | 'JD' | 'SECOND' | 'THIRD' — Suffix for name - `preferred` string — Informal preferred name added by traveler. This is not used on any PNR or tickets - `title` 'TITLE_UNKNOWN' | 'MR' | 'MS' | 'MRS' | 'MX' | 'MASTER' | 'MISS' | 'DR' | 'PROFESSOR' | 'CAPTAIN' | 'REVEREND' | 'HONOURABLE' | 'SIR' | 'LADY' | 'AMBASSADOR' | 'LORD' | 'BRIGADIER' | 'SENATOR' | 'DAME' | 'JUSTICE' | 'UK' | 'TITLE_REDACTED' - `gender` 'MALE' | 'FEMALE' | 'UNSPECIFIED' | 'UNDISCLOSED' | 'GENDER_REDACTED' - `pronoun` 'SHE_HER_HERS' | 'HE_HIM_HIS' | 'THEY_THEM_THEIRS' - `preferredLanguage` string — Preferred language of the user - `nationality` string — Nationality of the user - `profilePicture` Image — An image with meta data. Either the `data` or `url` property must be supplied to load the image. - `data` string, byte - `dimensions` Dimensions — Image dimensions ie width and height. - `height` integer - `width` integer - `url` string - `businessDetail` BusinessDetail, required — Business details of the user - `legalEntity` Reference, required — Reference of an entity - `id` string, uuid, required - `name` string - `office` Reference — Reference of an entity - `id` string, uuid, required - `name` string - `department` Reference — Reference of an entity - `id` string, uuid, required - `name` string - `costCenter` Reference — Reference of an entity - `id` string, uuid, required - `name` string - `businessEmail` string — Business email of the user. - `designation` string — Designation or job title of the user. - `employeeId` string — Employee ID of the user. - `createdAt` DateTimeLocal, required — Local date and time in ISO 8601 format. - `iso8601` string, required - `lastUpdatedAt` DateTimeLocal, required — Local date and time in ISO 8601 format. - `iso8601` string, required - `pagination` OffsetBasedPaginationResponseParams — Pagination parameters for response. - `totalNumResults` integer, required — Total number of results. ## Other responses - `401` — Unauthorized - `403` — Forbidden - `404` — The specified resource was not found. --- [API](https://skmtc.net/spotnana/apis/user-management-api.md) · [All operations](https://skmtc.net/spotnana/apis/user-management-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/spotnana/user-management-api/versions/920fb84cbf70/schema)