---
updatedAt: 2026-05-27T12:50:22.000Z
agentTools:
  projectIndex: https://developer.onetrust.com/onetrust/llms.txt
---

# Get Full Object Details

Use this API to retrieve all the details for the specified object record by key terms and filters.

> 🗒 Things to Know
> 
> - This API only supports objects created via Object Manager, including Projects, Models, and Datasets.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Platform - Object Manager",
    "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 Object Manager APIs are used to integrate external systems and streamline the flow of data for objects created via Object Manager in the OneTrust Platform."
  },
  "servers": [
    {
      "url": "https://{hostname}/api/custom-entity",
      "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": "Object Management",
      "description": "The Object Management APIs are used to manage objects created via Object Manager, including Projects, Models, and Datasets.",
      "externalDocs": {
        "description": "OpenAPI 3.1.0 - Download Definition",
        "url": "https://developer.onetrust.com/onetrust/openapi/platform-object-manager.json"
      }
    }
  ],
  "x-onetrust": {
    "spec-label": "OpenAPI 3.1.0",
    "links": [
      "{'Object Manager': 'https://my.onetrust.com/s/topic/0TO3q000000JPkQGAW/object-manager'}"
    ]
  },
  "x-readme": {
    "explorer-enabled": false,
    "proxy-enabled": false,
    "metrics-enabled": false
  },
  "paths": {
    "/v1/entities/search": {
      "post": {
        "operationId": "findAllByTypeIdAndCriteriaUsingPOST",
        "summary": "Get Full Object Details",
        "description": "Use this API to retrieve all the details for the specified object record by key terms and filters.\n\n> 🗒 Things to Know\n> \n> - This API only supports objects created via Object Manager, including Projects, Models, and Datasets.",
        "tags": [
          "Object Management"
        ],
        "x-onetrust": {
          "spec-label": "https://developer.onetrust.com/onetrust/openapi/platform-object-manager.json"
        },
        "parameters": [
          {
            "name": "page",
            "in": "query",
            "description": "The page number of the results.",
            "schema": {
              "description": "Results page to be retrieved (0..N). Example- '?page=1",
              "type": "integer",
              "format": "int32",
              "default": 0,
              "minimum": 0
            },
            "example": 1
          },
          {
            "name": "size",
            "in": "query",
            "description": "The number of results per page.",
            "schema": {
              "description": "Number of records per page (1..50). Example- '?size=20",
              "type": "integer",
              "format": "int32",
              "default": 10,
              "maximum": 2000,
              "minimum": 1
            },
            "example": 50
          },
          {
            "name": "sort",
            "in": "query",
            "description": "The sort criteria that dictates the order of the results.",
            "schema": {
              "type": "string",
              "enum": [
                "name,asc",
                "name,desc"
              ]
            },
            "example": "name,asc"
          },
          {
            "name": "entityTypeId",
            "in": "query",
            "description": "The unique identifier of the object type.",
            "required": false,
            "schema": {
              "description": "Identifier of the object type",
              "type": "string",
              "format": "uuid"
            },
            "example": "2aa71ead-0c9a-416a-8471-bdfb67c8d113"
          },
          {
            "name": "entityTypeName",
            "in": "query",
            "description": "The name of the object type.",
            "required": false,
            "schema": {
              "description": "Name of the object type",
              "type": "string"
            },
            "example": "vendors"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "Search parameters including filtering criteria, pagination settings, and sort order",
                "$ref": "#/components/schemas/EntityListRequest"
              },
              "examples": {
                "Complex Search Example": {
                  "summary": "Search with multiple conditions",
                  "description": "Example request with multiple search conditions and pagination settings",
                  "value": {
                    "queryRequest": {
                      "criteria": {
                        "fullText": "",
                        "filters": [
                          {
                            "field": "description",
                            "value": "desc",
                            "operator": "EQUAL_TO"
                          },
                          {
                            "field": "projectOwner",
                            "value": [
                              "41955b71-e581-4187-ab6c-d00d1403350c"
                            ],
                            "operator": "EQUAL_TO"
                          },
                          {
                            "field": "attributeTextValue.value2",
                            "value": "2025-06-10T18:30:00.000Z",
                            "toValue": "2025-06-12T18:30:00.000Z",
                            "operator": "BETWEEN"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK - Successfully retrieved matching objects",
            "content": {
              "application/json": {
                "schema": {
                  "description": "Paginated list of detailed object information matching the search criteria",
                  "$ref": "#/components/schemas/PageEntityInformation"
                },
                "examples": {
                  "Projects List Response": {
                    "summary": "Paginated list of projects",
                    "description": "Example response showing a paginated list of projects with attributes and relationships",
                    "value": {
                      "content": [
                        {
                          "businessValue": [
                            {
                              "id": null,
                              "value": "1",
                              "disabled": false
                            }
                          ],
                          "createdBy": [
                            {
                              "id": "41955b71-e581-4187-ab6c-d00d1403350c",
                              "value": "Arpita K",
                              "disabled": false
                            }
                          ],
                          "createdDate": "2025-06-12T12:24:51.740Z",
                          "deadline": [
                            {
                              "id": null,
                              "value": "2025-06-29",
                              "disabled": false
                            }
                          ],
                          "description": [
                            {
                              "id": null,
                              "value": "desc",
                              "disabled": false
                            }
                          ],
                          "entityType": {
                            "id": "ef4e5bf9-7462-43af-b74f-72b61308629b",
                            "name": "projects",
                            "nameKey": "CE.Projects.Name",
                            "seeded": true,
                            "moduleName": "CustomEntityManagement",
                            "schemaName": "projects"
                          },
                          "id": "8dca92a3-e2e7-495e-8278-94fd38e1cfae",
                          "internalOrExternal": [
                            {
                              "id": "43496a9a-8319-49df-b5c3-7fdd2d31ee3f",
                              "value": "Internal",
                              "valueKey": "CE.Projects.Attribute.InternalOrExternal.Option.Internal",
                              "disabled": false
                            }
                          ],
                          "lastModifiedBy": [
                            {
                              "id": "41955b71-e581-4187-ab6c-d00d1403350c",
                              "value": "Arpita K",
                              "disabled": false
                            }
                          ],
                          "lastModifiedDate": "2025-06-12T12:24:52.260Z",
                          "name": "test",
                          "number": 159,
                          "openItemsCount": [
                            {
                              "id": null,
                              "value": "0",
                              "disabled": false
                            }
                          ],
                          "organization": {
                            "id": "c9e5a35b-9be7-4dd6-adac-0bee7c02384f",
                            "name": "PLTF REP"
                          },
                          "schemaId": "fc39968b-9393-4041-8712-e50da2f19e03",
                          "stage": {
                            "id": "0f304090-d19d-4749-9bac-a59efba81699",
                            "name": "Not Started",
                            "nameKey": "CE.Workflow.Stage.NotStarted",
                            "badgeColor": "New",
                            "sequence": null
                          },
                          "status": [
                            {
                              "id": "23d1e72f-d3ce-43a2-bb72-89cc2edaa6fa",
                              "value": "Pending",
                              "valueKey": "CE.Projects.Attribute.Status.Option.Pending",
                              "disabled": false
                            }
                          ],
                          "timeToReview": [
                            {
                              "id": null,
                              "value": "0.06",
                              "disabled": false
                            }
                          ],
                          "type": [
                            {
                              "id": "996d4292-7a59-4c78-9d34-cb7d903d847f",
                              "value": "AI",
                              "valueKey": "CE.Projects.Attribute.Type.Option.AI",
                              "disabled": false
                            }
                          ],
                          "workflow": {
                            "id": "c86bffc1-6bd5-414b-816e-dfe330a9c7f5",
                            "name": "MS Workflow",
                            "nameKey": null,
                            "type": "ef4e5bf9-7462-43af-b74f-72b61308629b",
                            "workflowMode": "ADVANCED"
                          }
                        },
                        {
                          "createdBy": [
                            {
                              "id": "41955b71-e581-4187-ab6c-d00d1403350c",
                              "value": "Arpita K",
                              "disabled": false
                            }
                          ],
                          "createdDate": "2025-06-10T06:52:30.377Z",
                          "deadline": [
                            {
                              "id": null,
                              "value": "2025-06-18",
                              "disabled": false
                            }
                          ],
                          "description": [
                            {
                              "id": null,
                              "value": "desc",
                              "disabled": false
                            }
                          ],
                          "entityType": {
                            "id": "ef4e5bf9-7462-43af-b74f-72b61308629b",
                            "name": "projects",
                            "nameKey": "CE.Projects.Name",
                            "seeded": true,
                            "moduleName": "CustomEntityManagement",
                            "schemaName": "projects"
                          },
                          "externalId": [
                            {
                              "id": null,
                              "value": "PROJ-2025-002",
                              "disabled": false
                            }
                          ],
                          "id": "4faac997-83c2-4137-9d5c-273eb6457552",
                          "intendedUse": [
                            {
                              "id": null,
                              "value": "Improve data analytics capabilities and reduce operational costs",
                              "disabled": false
                            }
                          ],
                          "internalOrExternal": [
                            {
                              "id": "43496a9a-8319-49df-b5c3-7fdd2d31ee3f",
                              "value": "Internal",
                              "valueKey": "CE.Projects.Attribute.InternalOrExternal.Option.Internal",
                              "disabled": false
                            }
                          ],
                          "lastModifiedBy": [
                            {
                              "id": "41955b71-e581-4187-ab6c-d00d1403350c",
                              "value": "Arpita K",
                              "disabled": false
                            }
                          ],
                          "lastModifiedDate": "2025-06-11T11:03:24.203Z",
                          "name": "test_0610_01",
                          "number": 155,
                          "organization": {
                            "id": "c9e5a35b-9be7-4dd6-adac-0bee7c02384f",
                            "name": "PLTF REP"
                          },
                          "projectLink": [
                            {
                              "id": null,
                              "value": "https://project-tracker.example.com/projects/PROJ-2025-002",
                              "disabled": false
                            }
                          ],
                          "projectOwner": [
                            {
                              "id": "41955b71-e581-4187-ab6c-d00d1403350c",
                              "value": "Arpita K",
                              "disabled": false
                            }
                          ],
                          "schemaId": "fc39968b-9393-4041-8712-e50da2f19e03",
                          "stage": {
                            "id": "0f304090-d19d-4749-9bac-a59efba81699",
                            "name": "Not Started",
                            "nameKey": "CE.Workflow.Stage.NotStarted",
                            "badgeColor": "New",
                            "sequence": null
                          },
                          "status": [
                            {
                              "id": "23d1e72f-d3ce-43a2-bb72-89cc2edaa6fa",
                              "value": "Pending",
                              "valueKey": "CE.Projects.Attribute.Status.Option.Pending",
                              "disabled": false
                            }
                          ],
                          "type": [
                            {
                              "id": "996d4292-7a59-4c78-9d34-cb7d903d847f",
                              "value": "AI",
                              "valueKey": "CE.Projects.Attribute.Type.Option.AI",
                              "disabled": false
                            }
                          ],
                          "workflow": {
                            "id": "c86bffc1-6bd5-414b-816e-dfe330a9c7f5",
                            "name": "MS Workflow",
                            "nameKey": null,
                            "type": "ef4e5bf9-7462-43af-b74f-72b61308629b",
                            "workflowMode": "ADVANCED"
                          }
                        }
                      ],
                      "pageable": {
                        "pageNumber": 0,
                        "pageSize": 20,
                        "sort": {
                          "empty": false,
                          "sorted": true,
                          "unsorted": false
                        },
                        "offset": 0,
                        "unpaged": false,
                        "paged": true
                      },
                      "last": true,
                      "totalPages": 1,
                      "totalElements": 2,
                      "size": 20,
                      "number": 0,
                      "sort": {
                        "empty": false,
                        "sorted": true,
                        "unsorted": false
                      },
                      "first": true,
                      "numberOfElements": 2,
                      "empty": false
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "Forbidden"
          },
          "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": [
          {
            "OAUTH2": [
              "OBJECT_MANAGER",
              "OBJECT_MANAGER_READ",
              "OBJECT_MANAGER_WRITE"
            ]
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "AttributeValueInformation": {
        "type": "object",
        "properties": {
          "id": {
            "description": "The unique identifier of the attribute.",
            "type": "string",
            "format": "uuid",
            "example": "a34ccec7-1ec0-4d65-9075-bdd0d923f1d1"
          },
          "value": {
            "description": "The name of the attribute.",
            "type": "string",
            "example": "Text Value"
          },
          "valueKey": {
            "description": "The name key of the attribute used for translation purposes.",
            "type": "string",
            "example": "attribute.option.valueKey"
          },
          "colorCode": {
            "description": "The color code associated with the attribute.",
            "type": "string",
            "example": "red"
          },
          "optionSelectionValue": {
            "description": "The selection value of the attribute.",
            "type": "string",
            "example": 3.5
          },
          "displayLabel": {
            "description": "The display label for the attribute.",
            "type": "string",
            "example": "United State | San Francisco"
          },
          "disabled": {
            "description": "This flag indicates whether the attribute is disabled.",
            "type": "boolean",
            "example": false,
            "default": "false"
          }
        },
        "required": [
          "value"
        ]
      },
      "BasicEntityTypeInformation": {
        "type": "object",
        "properties": {
          "id": {
            "description": "The unique identifier of the object type.",
            "type": "string",
            "format": "uuid",
            "example": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
          },
          "name": {
            "description": "The name of the object type.",
            "type": "string",
            "example": "Vendor"
          },
          "seeded": {
            "description": "This flag indicates whether the object type is seeded. ",
            "type": "boolean",
            "example": true
          },
          "moduleName": {
            "description": "The name of the product where the object type exists.",
            "type": "string",
            "example": "Vendor",
            "enum": [
              "Vendor",
              "DataMapping",
              "Risk",
              "Assessments",
              "CustomEntityManagement"
            ]
          },
          "schemaName": {
            "description": "The name of the schema.",
            "type": "string",
            "example": "vendor",
            "enum": [
              "vendor",
              "data-mapping",
              "risk",
              "assessments",
              "customEntityManagement"
            ]
          }
        },
        "example": "{\n \"id\": \"f2229953-b4b5-4042-8cb9-b78038cc4c46\",\n \"name\": \"Vendor\",\n \"nameKey\": \"EntityType.Vendor.Name\",\n \"seeded\": true,\n \"moduleName\": \"Vendor\",\n \"schemaName\": \"vendor\"\n},\n",
        "required": [
          "id",
          "name"
        ]
      },
      "EntityBasicUserInformation": {
        "type": "object",
        "properties": {
          "id": {
            "description": "The unique identifier of the user who last modified the record.",
            "type": "string",
            "format": "uuid",
            "example": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
          },
          "name": {
            "description": "The name of the user who last modified the record.",
            "type": "string",
            "example": "First Last"
          },
          "email": {
            "description": "The email address of the user who last modified the record.",
            "type": "string",
            "example": "user@gmail.com"
          },
          "initials": {
            "description": "The initials of the user who last modified the record.",
            "type": "string",
            "example": "FL"
          }
        }
      },
      "EntityInformation": {
        "type": "object",
        "properties": {
          "id": {
            "description": "The unique identifier of the object.",
            "type": "string",
            "format": "uuid",
            "example": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
            "readOnly": true
          },
          "number": {
            "description": "The sequential order in which the object was created.",
            "type": "integer",
            "format": "int64",
            "example": 1,
            "maximum": 9999999,
            "minimum": 1,
            "readOnly": true
          },
          "name": {
            "description": "The name of the object.",
            "type": "string",
            "example": "OneTrust",
            "maxLength": 255,
            "minLength": 1
          },
          "orgGroupId": {
            "description": "The unique identifier of the organization responsible for the object.",
            "type": "string",
            "format": "uuid",
            "example": "d1119953-b4b5-4042-8cb9-b78038cc2c46"
          },
          "schemaId": {
            "description": "The unique identifier of the schema.",
            "type": "string",
            "format": "uuid",
            "example": "c21319953-b4b5-4042-8cb9-b78038cc4c51",
            "readOnly": true
          },
          "entityType": {
            "description": "The details of the object type.",
            "example": {
              "id": "a2319953-b4b5-4042-8cb9-b78038cc4c46",
              "name": "Asset"
            },
            "$ref": "#/components/schemas/BasicEntityTypeInformation"
          },
          "workflowAndStage": {
            "description": "The details of the workflow and stage.",
            "example": {
              "id": "b271c01a-89a9-41b1-8185-0a3e2bfdad84",
              "name": "Vendor On-Boarding Workflow",
              "nameKey": "Workflow.VendorOnBoarding.Name",
              "type": "Vendor",
              "workflowMode": "BASIC",
              "stageId": "9fc111cb-c379-4f08-8aff-5be954c1a6e6",
              "stageName": "Start On-Boarding",
              "stageNameKey": "Workflow.VendorOnBoarding.Stage.StartOnBoarding",
              "badgeColor": "#4287f5"
            },
            "$ref": "#/components/schemas/EntityWorkflowInformation"
          },
          "attributes": {
            "description": "The details of the associated attributes.",
            "type": "object",
            "example": {
              "textAttributeName": [
                {
                  "value": "Text"
                }
              ],
              "optionBasedAttributeName": [
                {
                  "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
                }
              ]
            },
            "additionalProperties": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/AttributeValueInformation"
              }
            }
          },
          "auditFields": {
            "description": "The activity details of when the record was created and last updated.",
            "example": {
              "createdBy": "admin@example.com",
              "createdTimestamp": "2023-01-15T10:30:45Z",
              "lastModifiedBy": "system@example.com",
              "lastModifiedTimestamp": "2025-03-22T14:15:22Z"
            },
            "$ref": "#/components/schemas/EntityRecordAuditInformation",
            "readOnly": true
          }
        },
        "example": {
          "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
          "name": "OneTrust",
          "entityType": {
            "id": "d1119953-b4b5-4042-8cb9-b78038cc2c46",
            "name": "Vendor"
          }
        },
        "required": [
          "entityType",
          "id",
          "name",
          "number",
          "schemaId"
        ],
        "title": "Entity Information"
      },
      "EntityRecordAuditInformation": {
        "type": "object",
        "properties": {
          "createdDate": {
            "description": "The date and time that the record was created.",
            "type": "string",
            "format": "date-time",
            "example": "2021-05-13T13:06:49.853Z"
          },
          "lastUpdatedDate": {
            "description": "The date and time that the record was last updated.",
            "type": "string",
            "format": "date-time",
            "example": "2021-05-13T13:06:49.853Z"
          },
          "createdBy": {
            "description": "The creation details of the record.",
            "example": {
              "id": "c21319953-b4b5-4042-8cb9-b78038cc4c51",
              "name": "Name"
            },
            "$ref": "#/components/schemas/EntityBasicUserInformation"
          },
          "lastModifiedBy": {
            "description": "The last modified details of the record.",
            "example": {
              "id": "c21319953-b4b5-4042-8cb9-b78038cc4c51",
              "name": "Name"
            },
            "$ref": "#/components/schemas/EntityBasicUserInformation"
          }
        },
        "required": [
          "createdDate"
        ]
      },
      "EntityWorkflowInformation": {
        "type": "object",
        "properties": {
          "id": {
            "description": "The unique identifier of the workflow.",
            "type": "string",
            "format": "uuid",
            "example": "b271c01a-89a9-41b1-8185-0a3e2bfdad84"
          },
          "name": {
            "description": "The name of the workflow.",
            "type": "string",
            "example": "Vendor On-Boarding Workflow"
          },
          "type": {
            "description": "The type of workflow.",
            "type": "string",
            "example": "Vendor"
          },
          "workflowMode": {
            "description": "The mode in which the workflow was created.",
            "type": "string",
            "example": "BASIC",
            "enum": [
              "ADVANCED, BASIC"
            ]
          },
          "stageId": {
            "description": "The unique identifier of the workflow stage.",
            "type": "string",
            "format": "uuid",
            "example": "9fc111cb-c379-4f08-8aff-5be954c1a6e6"
          },
          "stageName": {
            "description": "The name of the workflow stage.",
            "type": "string",
            "example": "Start On-Boarding"
          }
        },
        "example": {
          "id": "b271c01a-89a9-41b1-8185-0a3e2bfdad84",
          "name": "Vendor On-Boarding Workflow",
          "nameKey": "Workflow.VendorOnBoarding.Name",
          "type": "Vendor",
          "workflowMode": "BASIC",
          "stageId": "9fc111cb-c379-4f08-8aff-5be954c1a6e6",
          "stageName": "Start On-Boarding",
          "stageNameKey": "Workflow.VendorOnBoarding.Stage.StartOnBoarding",
          "badgeColor": "#4287f5"
        },
        "required": [
          "id",
          "name",
          "stageId",
          "stageName",
          "type"
        ]
      },
      "AttributePredicate": {
        "type": "object",
        "properties": {
          "field": {
            "description": "The field by which to filter results.",
            "type": "string"
          },
          "operator": {
            "description": "The relationship that must be met between the field and the value.",
            "type": "string",
            "enum": [
              "EQUAL_TO",
              "NOT_EQUAL_TO",
              "GREATER_THAN",
              "GREATER_THAN_EQUAL_TO",
              "LESS_THAN",
              "LESS_THAN_EQUAL_TO",
              "BETWEEN"
            ]
          },
          "value": {
            "description": "The value by which to filter results.",
            "type": "object",
            "oneOf": [
              {
                "type": "string",
                "format": "uuid"
              },
              {
                "type": "string",
                "format": "date"
              },
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "string"
              },
              {
                "type": "number"
              }
            ]
          },
          "toValue": {
            "description": "The end value by which to filter results.",
            "type": "object",
            "oneOf": [
              {
                "type": "string",
                "format": "date"
              },
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "string"
              },
              {
                "type": "number"
              }
            ]
          }
        },
        "required": [
          "field"
        ]
      },
      "AttributeQueryCriteria": {
        "type": "object",
        "properties": {
          "filters": {
            "description": "The criteria used to filter results.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AttributePredicate"
            },
            "uniqueItems": true
          },
          "fullText": {
            "description": "The key terms for the search criteria.",
            "type": "string"
          }
        }
      },
      "Sort": {
        "type": "object",
        "properties": {
          "sorted": {
            "description": "This flag indicates whether the results were sorted.",
            "type": "boolean",
            "example": true
          },
          "unsorted": {
            "description": "This flag indicates whether the results were unsorted.",
            "type": "boolean",
            "example": false
          },
          "empty": {
            "description": "This flag indicates whether sort criteria was left undefined.",
            "type": "boolean",
            "example": false
          }
        }
      },
      "EntityQueryRequest": {
        "type": "object",
        "properties": {
          "criteria": {
            "description": "The details of the filter criteria.",
            "example": {
              "filters": [
                {
                  "fieldName": "name",
                  "operator": "contains",
                  "value": "OneTrust"
                }
              ],
              "searchQuery": "privacy",
              "sort": [
                {
                  "fieldName": "lastModifiedTimestamp",
                  "direction": "DESC"
                }
              ]
            },
            "$ref": "#/components/schemas/AttributeQueryCriteria"
          },
          "organizationTraversalStrategy": {
            "description": "The strategy used to return objects within the organizational hierarchy.",
            "type": "string",
            "example": "ancestors_and_descendants",
            "enum": [
              "ancestors_and_descendants",
              "descendants",
              "all"
            ]
          },
          "requestedOrganizationId": {
            "description": "The unique identifier of the organization for the request.",
            "type": "string",
            "format": "uuid",
            "example": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
          },
          "queryAction": {
            "description": "The action specifying the source of the API request.",
            "type": "string",
            "example": "ListEntity"
          }
        },
        "example": {
          "criteria": {
            "filters": [
              {
                "fieldName": "name",
                "operator": "contains",
                "value": "OneTrust"
              },
              {
                "fieldName": "entityStatus",
                "operator": "equals",
                "value": "Active"
              },
              {
                "fieldName": "lastModifiedTimestamp",
                "operator": "greaterThan",
                "value": "2024-01-01T00:00:00Z"
              }
            ],
            "searchQuery": "privacy",
            "sort": [
              {
                "fieldName": "lastModifiedTimestamp",
                "direction": "DESC"
              }
            ]
          },
          "organizationTraversalStrategy": "ancestors_and_descendants",
          "requestedOrganizationId": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
          "queryAction": "ListEntity"
        }
      },
      "ContextInformation": {
        "type": "object",
        "properties": {
          "parameters": {
            "description": "This parameter can be used to store details in key value pairs.",
            "additionalProperties": {
              "type": "object"
            },
            "type": "object"
          }
        }
      },
      "EntityFieldRequest": {
        "type": "object",
        "properties": {
          "fields": {
            "description": "The name of the field.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": [
              "textAttributeField1",
              "singleSelectAttributeField1"
            ]
          },
          "mode": {
            "description": "The mode in which non-required fields would be selected.",
            "type": "string",
            "default": "select_all",
            "enum": [
              "select_all",
              "ignore_all",
              "specific"
            ]
          },
          "includeSelectedFullTextSearchFields": {
            "description": "This flag indicates whether to include selected full text search fields.",
            "type": "boolean",
            "example": true
          },
          "overriddenSearchFields": {
            "description": "The overridden search fields.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": [
              "name"
            ]
          }
        },
        "required": [
          "mode"
        ]
      },
      "EntityListRequest": {
        "type": "object",
        "properties": {
          "context": {
            "description": "The contextual details of the object.",
            "$ref": "#/components/schemas/ContextInformation"
          },
          "queryRequest": {
            "description": "The details of the filter, text, and organization search criteria.",
            "$ref": "#/components/schemas/EntityQueryRequest"
          },
          "requestedFields": {
            "description": "The details of the non-required fields to include in the response.",
            "$ref": "#/components/schemas/EntityFieldRequest"
          }
        },
        "example": {
          "queryRequest": {
            "criteria": {
              "filters": [
                {
                  "fieldName": "name",
                  "operator": "contains",
                  "value": "OneTrust"
                },
                {
                  "fieldName": "entityStatus",
                  "operator": "equals",
                  "value": "Active"
                }
              ],
              "searchQuery": "gdpr",
              "sort": [
                {
                  "fieldName": "lastModifiedTimestamp",
                  "direction": "DESC"
                }
              ]
            },
            "organizationTraversalStrategy": "ancestors_and_descendants",
            "requestedOrganizationId": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
            "queryAction": "ListEntity"
          },
          "requestedFields": {
            "includeStandardFields": true,
            "includeCustomFields": true,
            "includeAuditFields": false,
            "specificStandardFields": [
              "name",
              "entityNumber",
              "createdBy"
            ],
            "specificCustomFields": [
              "vendor_tier",
              "risk_score"
            ]
          }
        }
      },
      "PageEntityInformation": {
        "type": "object",
        "properties": {
          "content": {
            "description": "The data of the returned objects.",
            "example": [
              {
                "entityType": "Customer",
                "idType": "UUID",
                "javaType": "com.example.Customer"
              }
            ],
            "items": {
              "$ref": "#/components/schemas/EntityInformation"
            },
            "type": "array"
          },
          "totalElements": {
            "description": "The total number of results in the list.",
            "type": "integer",
            "format": "int64",
            "example": 100,
            "minimum": 0
          },
          "totalPages": {
            "description": "The total number of pages in the list.",
            "type": "integer",
            "format": "int32",
            "example": 10,
            "minimum": 0
          },
          "number": {
            "description": "The page number of the results.",
            "type": "integer",
            "format": "int32",
            "example": 0,
            "minimum": 0
          },
          "size": {
            "description": "The number of results per page.",
            "type": "integer",
            "format": "int32",
            "example": 10,
            "maximum": 1000,
            "minimum": 20
          },
          "first": {
            "description": "This flag indicates whether the current page is the first page of the list.",
            "type": "boolean",
            "example": true
          },
          "last": {
            "description": "This flag indicates whether the current page is the last page of the list.",
            "type": "boolean",
            "example": false
          },
          "empty": {
            "description": "The flag indicates whether no results exist on the page.",
            "type": "boolean",
            "example": false
          },
          "numberOfElements": {
            "description": "The number of results on the current page.",
            "type": "integer",
            "format": "int32",
            "example": 10,
            "minimum": 0
          },
          "hasNext": {
            "description": "This flag indicates whether there is a next page in the list.",
            "type": "boolean",
            "example": true
          },
          "hasPrevious": {
            "description": "This flag indicates whether there is a previous page in the list.",
            "type": "boolean",
            "example": false
          },
          "sort": {
            "description": "The sort criteria that dictates the order of the results.",
            "$ref": "#/components/schemas/Sort"
          }
        },
        "example": {
          "content": [
            {
              "entityType": "Customer",
              "idType": "UUID",
              "javaType": "com.example.Customer"
            }
          ],
          "totalElements": 100,
          "totalPages": 10,
          "number": 0,
          "size": 10,
          "first": true,
          "last": false,
          "empty": false,
          "numberOfElements": 10
        },
        "required": [
          "content",
          "empty",
          "first",
          "hasNext",
          "hasPrevious",
          "last",
          "number",
          "numberOfElements",
          "size",
          "totalElements",
          "totalPages"
        ]
      }
    },
    "securitySchemes": {
      "OAUTH2": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://{hostname}/api/access/v1/oauth/token",
            "scopes": {
              "OBJECT_MANAGER": "Grants full access to Object Manager related APIs.",
              "OBJECT_MANAGER_READ": "Grants read access to Object Manager related APIs",
              "OBJECT_MANAGER_WRITE": "Grants write access to Object Manager related APIs"
            }
          }
        }
      }
    }
  }
}
```

# Sibling pages

* [Create Object](https://developer.onetrust.com/onetrust/reference/addentityusingentitytypeidorentitytypenameusingpost.md)
* [Delete Object](https://developer.onetrust.com/onetrust/reference/deleteusingentitytypeidorentitytypenameusingdelete.md)
* [Get Object](https://developer.onetrust.com/onetrust/reference/getentityinformationusingentitytypeidorentitytypenameusingget.md)
* [Modify Object](https://developer.onetrust.com/onetrust/reference/updateusingentitytypeidorentitytypenameusingpatch.md)
* [Get Basic Object Details](https://developer.onetrust.com/onetrust/reference/findentitybasicdetailsbytypeandcriteriausingpost.md)