> ## Documentation Index
> Fetch the complete documentation index at: https://developer.onetrust.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get List of Entity Types

Use this API to retrieve a list of all entity types by key terms and filters.

> 🗒 Things to Know
> 
> - This API only supports AI Governance entities (Models, Datasets, AI Systems, and AI Agents).
> - AI Governance APIs will become available over the course of the Spring as customer tenants are upgraded to enhanced AI Governance services. No customer action is required and more detailed information will be published in upcoming release notes and product documentation.  

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "AI Governance - AI Governance",
    "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 AI Governance APIs are used to integrate external systems and streamline the flow of data with AI Governance in the 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": "Entity Type Management",
      "description": "The Entity Type Management APIs are used to manage AI Governance entity types.",
      "externalDocs": {
        "description": "OpenAPI 3.1.0 - Download Definition",
        "url": "https://developer.onetrust.com/onetrust/openapi/ai-governance.json"
      }
    }
  ],
  "x-onetrust": {
    "spec-label": "OpenAPI 3.1.0"
  },
  "x-readme": {
    "explorer-enabled": false,
    "proxy-enabled": false,
    "metrics-enabled": false
  },
  "paths": {
    "/api/ai-governance/v1/entity-types/search": {
      "post": {
        "operationId": "findAllByTypeAndCriteriaUsingPOST_1",
        "summary": "Get List of Entity Types",
        "description": "Use this API to retrieve a list of all entity types by key terms and filters.\n\n> 🗒 Things to Know\n> \n> - This API only supports AI Governance entities (Models, Datasets, AI Systems, and AI Agents).\n> - AI Governance APIs will become available over the course of the Spring as customer tenants are upgraded to enhanced AI Governance services. No customer action is required and more detailed information will be published in upcoming release notes and product documentation.  ",
        "tags": [
          "Entity Type Management"
        ],
        "x-onetrust": {
          "spec-label": "https://developer.onetrust.com/onetrust/openapi/ai-governance.json"
        },
        "parameters": [
          {
            "name": "page",
            "in": "query",
            "description": "Results page to be retrieved (0..N). Example: '?page=1'",
            "schema": {
              "type": "integer",
              "default": 0
            }
          },
          {
            "name": "size",
            "in": "query",
            "description": "Number of records per page (1..50). Example: '?size=20'",
            "schema": {
              "type": "integer",
              "default": 20,
              "maximum": 50,
              "minimum": 1
            }
          },
          {
            "name": "sort",
            "in": "query",
            "description": "Sorting criteria in the format: property,(asc|desc). Example: '?sort=name,asc'",
            "schema": {
              "type": "string",
              "default": "name,asc",
              "enum": [
                "name,asc",
                "name,desc"
              ]
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AttributeQueryCriteria"
              },
              "examples": {
                "Search System and Active Entity Types": {
                  "summary": "Example of searching for system and active entity types containing 'dataset' in name",
                  "description": "Search System and Active Entity Types",
                  "value": {
                    "fullText": "DataSets",
                    "filters": [
                      {
                        "field": "moduleScopes.module",
                        "value": [
                          "AIG"
                        ],
                        "operator": "EQUAL_TO"
                      },
                      {
                        "field": "enabled",
                        "value": [
                          true
                        ],
                        "operator": "EQUAL_TO"
                      },
                      {
                        "field": "seeded",
                        "value": [
                          true
                        ],
                        "operator": "EQUAL_TO"
                      }
                    ]
                  }
                },
                "Search Custom and Active Entity Types": {
                  "summary": "Example of searching for custom and active entity types containing 'Dataset' in name",
                  "description": "Search Custom and Active Entity Types",
                  "value": {
                    "fullText": "GR1",
                    "filters": [
                      {
                        "field": "moduleScopes.module",
                        "value": [
                          "DM"
                        ],
                        "operator": "EQUAL_TO"
                      },
                      {
                        "field": "enabled",
                        "value": [
                          true
                        ],
                        "operator": "EQUAL_TO"
                      },
                      {
                        "field": "seeded",
                        "value": [
                          false
                        ],
                        "operator": "EQUAL_TO"
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK - Returns a paginated list of entity types matching the criteria",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Page"
                },
                "examples": {
                  "Page of Entity Types": {
                    "summary": "Example of a page containing custom entity types",
                    "description": "Page of Entity Types",
                    "value": {
                      "content": [
                        {
                          "auditFields": {
                            "createdDate": "2023-02-20T17:32:03.770Z",
                            "lastUpdatedDate": "2023-02-24T14:45:10.230Z"
                          },
                          "description": "",
                          "descriptionKey": "f6d7977a-84d3-448d-9440-540fc5710b2f",
                          "enabled": true,
                          "id": "c02d15d7-ad0e-4d3b-9037-4580b5bdd7b1",
                          "moduleName": "AIGovernance",
                          "moduleScopes": [
                            "DM",
                            "ITRM"
                          ],
                          "name": "GR1",
                          "nameKey": "36ce5b96-000e-454d-84cd-ffa92f0b35c8",
                          "schemaName": "c248b17a-93ea-47e6-bd85-eecd71ce84a7",
                          "seeded": false,
                          "settings": {
                            "enableWorkflow": true,
                            "enableWorkflowStageTracking": true,
                            "enableAudit": true,
                            "assessable": true,
                            "enableTask": true,
                            "enableRisk": true,
                            "enableDocument": true,
                            "enableControl": true,
                            "enableWebForm": false,
                            "enableComment": false
                          },
                          "workflowType": "c02d15d7-ad0e-4d3b-9037-4580b5bdd7b1"
                        }
                      ],
                      "pageable": {
                        "pageNumber": 0,
                        "pageSize": 20,
                        "sort": {
                          "empty": false,
                          "sorted": true,
                          "unsorted": false
                        },
                        "offset": 0,
                        "paged": true,
                        "unpaged": false
                      },
                      "last": true,
                      "totalPages": 1,
                      "totalElements": 1,
                      "size": 20,
                      "number": 0,
                      "sort": {
                        "empty": false,
                        "sorted": true,
                        "unsorted": false
                      },
                      "first": true,
                      "numberOfElements": 1,
                      "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": [
              "AI_GOVERNANCE",
              "AI_GOVERNANCE_READ",
              "AI_GOVERNANCE_WRITE"
            ]
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "Page": {
        "type": "object",
        "properties": {
          "totalElements": {
            "type": "integer",
            "format": "int64"
          },
          "totalPages": {
            "type": "integer",
            "format": "int32"
          },
          "size": {
            "type": "integer",
            "format": "int32"
          },
          "content": {
            "items": {
              "type": "object"
            },
            "type": "array"
          },
          "number": {
            "type": "integer",
            "format": "int32"
          },
          "sort": {
            "$ref": "#/components/schemas/SortObject"
          },
          "first": {
            "type": "boolean"
          },
          "last": {
            "type": "boolean"
          },
          "pageable": {
            "$ref": "#/components/schemas/PageableObject"
          },
          "numberOfElements": {
            "type": "integer",
            "format": "int32"
          },
          "empty": {
            "type": "boolean"
          }
        }
      },
      "PageableObject": {
        "type": "object",
        "properties": {
          "offset": {
            "type": "integer",
            "format": "int64"
          },
          "sort": {
            "$ref": "#/components/schemas/SortObject"
          },
          "paged": {
            "type": "boolean"
          },
          "pageSize": {
            "type": "integer",
            "format": "int32"
          },
          "pageNumber": {
            "type": "integer",
            "format": "int32"
          },
          "unpaged": {
            "type": "boolean"
          }
        }
      },
      "SortObject": {
        "type": "object",
        "properties": {
          "empty": {
            "type": "boolean"
          },
          "sorted": {
            "type": "boolean"
          },
          "unsorted": {
            "type": "boolean"
          }
        }
      },
      "AttributePredicate": {
        "type": "object",
        "properties": {
          "field": {
            "description": "The field name used to filter results.",
            "type": "string"
          },
          "operator": {
            "description": "The relationship that must be met between the field and 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 field value used to filter results. If filtering for a range of values, this would be the start of the range and should be used in conjunction with the `toValue` parameter. \nExamples by type: UUID = 'e68d49c4-f11f-4cd9-8f1b-0be8ef945b8f', LocalDate = '2023-01-01', OffsetDateTime = '2023-01-01T00:00:00Z', String = 'Closed', Number = 7",
            "type": "object",
            "oneOf": [
              {
                "type": "string",
                "format": "uuid"
              },
              {
                "type": "string",
                "format": "date"
              },
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "string"
              },
              {
                "type": "number"
              }
            ]
          },
          "toValue": {
            "description": "The field value for the end of the range. This field should be used in conjunction with the `value` parameter. \nExamples by type: LocalDate = '2023-01-01', OffsetDateTime = '2023-01-01T00:00:00Z', String = 'Closed', Number = 7",
            "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 fields and values used to filter results.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AttributePredicate"
            },
            "uniqueItems": true
          },
          "fullText": {
            "description": "The key terms for the search criteria.",
            "type": "string",
            "maxLength": 500,
            "minLength": 0
          }
        }
      }
    },
    "securitySchemes": {
      "OAUTH2": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://{hostname}/api/access/v1/oauth/token",
            "scopes": {
              "AI_GOVERNANCE": "Grants full permissions to manage AI Governance operations for external systems",
              "AI_GOVERNANCE_READ": "Allows read-only access to AI Governance entities",
              "AI_GOVERNANCE_WRITE": "Grants permissions to create and modify AI Governance entities"
            }
          }
        }
      }
    }
  }
}
```