--- updatedAt: 2026-05-27T12:47:57.000Z agentTools: projectIndex: https://developer.onetrust.com/onetrust/llms.txt --- # Get List of Users Use this API to retrieve a list of all users in your account. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Platform - Access Management", "version": "1.0", "contact": { "name": "OneTrust Support", "url": "https://my.onetrust.com/s/contactsupport" }, "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0" }, "description": "The Access Management APIs enable you to programmatically control user access, manage organizational hierarchies, and monitor authentication activities across your OneTrust platform." }, "servers": [ { "url": "https://{hostname}", "variables": { "hostname": { "default": "hostname", "description": "The OneTrust hostname such as app.onetrust.com, app-eu.onetrust.com, app-de.onetrust.com, app-uk.onetrust.com, app-apac.onetrust.com, trial.onetrust.com, or uat.onetrust.com." } } } ], "tags": [ { "name": "Users V2", "description": "APIs to manage users and their memberships and access levels.", "externalDocs": { "description": "OpenAPI 3.1.0 - Download Definition", "url": "https://developer.onetrust.com/onetrust/openapi/platform-access-management.json" }, "x-displayName": "Users V2" } ], "paths": { "/api/access/v2/users": { "get": { "operationId": "getAllUserDetailsV2", "summary": "Get List of Users", "description": "Use this API to retrieve a list of all users in your account.", "tags": [ "Users V2" ], "x-onetrust": { "spec-label": "https://developer.onetrust.com/onetrust/openapi/platform-access-management.json" }, "parameters": [ { "name": "page", "in": "query", "description": "The page number for the results to be retrieved.", "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0 }, "example": 1 }, { "name": "size", "in": "query", "description": "The number of records to be retrieved per page.", "schema": { "type": "integer", "format": "int32", "default": 20, "maximum": 2000, "minimum": 1 }, "example": 20 }, { "name": "sort", "in": "query", "description": "The sorting criteria in the format: `property,(asc|desc)`. The default sort order is ascending. Multiple sort criteria are supported.", "schema": { "type": "string", "default": "name,asc", "enum": [ "name,asc", "name,desc", "email,asc", "email,desc", "organizationname,asc", "organizationname,desc" ] }, "example": "name,asc" } ], "responses": { "200": { "description": "User details retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Platform-AccessManagement_PagePublicOrgUserDetailsResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "429": { "description": "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).", "headers": { "Retry-After": { "schema": { "description": "The number of seconds after which requests will be allowed again.", "format": "int32" } }, "ot-period": { "schema": { "description": "The unit of time for which the rate limit applies", "enum": [ "HOUR", "MINUTE" ] } }, "ot-ratelimit-event-id": { "schema": { "description": "The unique identifier for the rate-limiting event.", "format": "uuid" } }, "ot-request-made": { "schema": { "description": "The number of requests made within the specified period.", "format": "int32" } }, "ot-requests-allowed": { "schema": { "description": "The number of requests allowed within the specified period.", "format": "int32" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "Platform-AccessManagement_OAUTH2": [ "USER" ] } ] } } }, "components": { "schemas": { "Platform-AccessManagement_PublicAccessLevelResponse": { "type": "object", "properties": { "organizationId": { "description": "The unique identifier of the organization.", "type": "string", "format": "uuid", "example": "423e4567-e89b-12d3-a456-426614174000" }, "organizationName": { "description": "The name of the organization.", "type": "string", "example": "My Org", "maxLength": 100, "minLength": 1 }, "roleId": { "description": "The unique identifier of the role.", "type": "string", "format": "uuid", "example": "423e4567-e89b-12d3-a456-426614174001" }, "roleName": { "description": "The name of the role.", "type": "string", "example": "Audit Manager", "maxLength": 256, "minLength": 1 } } }, "Platform-AccessManagement_PublicOrgUserDetailsResponse": { "type": "object", "properties": { "userId": { "description": "The unique identifier of the user.", "type": "string", "format": "uuid", "example": "423e4567-e89b-12d3-a456-426614174000" }, "firstName": { "description": "The first name of the user, as it appears in their profile.", "type": "string", "example": "Ross", "maxLength": 100 }, "lastName": { "description": "The last name of the user, as it appears in their profile.", "type": "string", "example": "Taylor", "maxLength": 100 }, "fullName": { "description": "The full name of the user, combining their first and last names.", "type": "string", "example": "Ross Taylor", "maxLength": 256 }, "email": { "description": "The email address associated with the user's account.", "type": "string", "format": "email", "example": "jane.doe@example.com", "maxLength": 255, "minLength": 5 }, "accessLevels": { "description": "The access levels assigned to the user.", "type": "array", "items": { "$ref": "#/components/schemas/Platform-AccessManagement_PublicAccessLevelResponse" }, "uniqueItems": true }, "emailConfirmed": { "description": "The indicator of whether the user's email address has been confirmed.", "type": "boolean", "example": true }, "active": { "description": "The indicator of whether the user account is currently active.", "type": "boolean", "example": true }, "internal": { "description": "The indicator of whether the user is an internal user, meaning they are part of the organization.", "type": "boolean", "example": false }, "externalId": { "description": "The external identifier for the user, which may be used to reference them in external systems.", "type": "string", "example": "ext-123456", "maxLength": 128 }, "expirationDateTime": { "description": "The date and time the user account will expire.", "type": "string", "format": "date-time", "example": "2025-01-01T12:00:00Z" }, "disabledDateTime": { "description": "The date and time the user account was disabled.", "type": "string", "format": "date-time", "example": "2024-06-15T08:30:00Z" }, "createdDate": { "description": "The date and time the user account was created.", "type": "string", "format": "date-time", "example": "2023-10-01T09:15:00Z" }, "lastModifiedDate": { "description": "The date and time the user account was last modified.", "type": "string", "format": "date-time", "example": "2024-02-20T14:45:00Z" }, "lastLoginDate": { "description": "The date and time the user last logged in.", "type": "string", "format": "date-time", "example": "2024-09-10T07:05:00Z" }, "disabledBy": { "description": "The name of the user who disabled the current user.", "type": "string", "example": "Michael Douglas", "maxLength": 256 }, "defaultOrganizationName": { "description": "The name of the default organization for the user.", "type": "string", "example": "My Org", "maxLength": 100 }, "defaultOrganizationId": { "description": "The unique identifier of the user's default organization.", "type": "string", "format": "uuid", "example": "423e4567-e89b-12d3-a456-426614174111" } } }, "Platform-AccessManagement_PagePublicOrgUserDetailsResponse": { "type": "object", "properties": { "content": { "description": "The list of users on the current page.", "items": { "$ref": "#/components/schemas/Platform-AccessManagement_PublicOrgUserDetailsResponse" }, "type": "array" }, "empty": { "description": "The flag to check if the result list is empty.", "type": "boolean" }, "first": { "description": "The flag to check if this is the first page.", "type": "boolean" }, "last": { "description": "The flag to check if this is the last page.", "type": "boolean" }, "number": { "description": "The current page number (0-based).", "type": "integer", "format": "int32" }, "numberOfElements": { "description": "The number of elements on the current page.", "type": "integer", "format": "int32", "example": 1 }, "size": { "description": "The page size.", "type": "integer", "format": "int32", "example": 20 }, "totalElements": { "description": "The total number of elements across all pages.", "type": "integer", "format": "int64", "example": 1 }, "totalPages": { "description": "The total number of pages.", "type": "integer", "format": "int32", "example": 1 }, "sort": { "$ref": "#/components/schemas/Platform-AccessManagement_SortObject" }, "pageable": { "description": "Pagination information with page number (0-based, min: 0) and page size (min: 1)", "type": "object", "example": { "offset": 0, "pageNumber": 0, "pageSize": 20, "paged": true, "sort": [ { "ascending": true, "descending": false, "direction": "ASC", "ignoreCase": false, "nullHandling": "NATIVE", "property": "name" } ], "unpaged": false } } } }, "Platform-AccessManagement_SortObject": { "type": "object", "properties": { "empty": { "description": "Indicates whether the result set is empty, meaning no records were found.", "type": "boolean" }, "sorted": { "description": "Indicates whether the results are sorted in a specific order, such as ascending or descending.", "type": "boolean" }, "unsorted": { "description": "The indicator of whether the results are unsorted.", "type": "boolean" } } } }, "securitySchemes": { "Platform-AccessManagement_OAUTH2": { "type": "oauth2", "flows": { "clientCredentials": { "tokenUrl": "https://{hostname}/api/access/v1/oauth/token", "scopes": { "ORGANIZATION": "Grants full access to manage organizations. This includes Create, Read, Update and Delete operations.", "USER": "Grants full access to manage Users, User Groups and User Group membership. This includes Create, Read, Update and Delete operations." } } } } } }, "x-readme": { "explorer-enabled": false, "proxy-enabled": false, "metrics-enabled": false }, "x-onetrust": { "spec-label": "OpenAPI 3.1.0" } } ``` # Sibling pages * [Create User](https://developer.onetrust.com/onetrust/reference/createuserv2.md) * [Get User](https://developer.onetrust.com/onetrust/reference/getuserv2.md) * [Update User](https://developer.onetrust.com/onetrust/reference/updateuserv2.md) * [Get User Roles](https://developer.onetrust.com/onetrust/reference/getuseraccesslevelsv2.md) * [Add User Role](https://developer.onetrust.com/onetrust/reference/adduseraccesslevelv2.md) * [Remove User Role](https://developer.onetrust.com/onetrust/reference/removeuseraccesslevelv2.md) * [Modify User Default Organization](https://developer.onetrust.com/onetrust/reference/setuserdefaultorganizationv2.md)