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

# Get Object Type by Name

Use this API to retrieve details for the object type by its name. The response will return the user who created the object type, created date, and description.

> 🗒 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 Type Management",
      "description": "The Object Type Management APIs are used to manage custom object types.",
      "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/entity-types/names/{entityTypeName}": {
      "get": {
        "operationId": "getEntityTypeInformationUsingGET_1",
        "summary": "Get Object Type by Name",
        "description": "Use this API to retrieve details for the object type by its name. The response will return the user who created the object type, created date, and description.\n\n> 🗒 Things to Know\n> \n> - This API only supports objects created via Object Manager, including Projects, Models, and Datasets.",
        "tags": [
          "Object Type Management"
        ],
        "x-onetrust": {
          "spec-label": "https://developer.onetrust.com/onetrust/openapi/platform-object-manager.json"
        },
        "parameters": [
          {
            "name": "entityTypeName",
            "in": "path",
            "description": "The name of the object type.",
            "required": true,
            "schema": {
              "description": "Name of the object type to retrieve. Can be used instead of entityTypeId.",
              "type": "string"
            },
            "example": "projects"
          }
        ],
        "responses": {
          "200": {
            "description": "OK - Returns the complete details of the requested object type",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EntityTypeInformation"
                },
                "examples": {
                  "Project Object Type": {
                    "summary": "Example of project object type details",
                    "description": "Project Object Type",
                    "value": {
                      "id": "ef4e5bf9-7462-43af-b74f-72b61308629b",
                      "name": "projects",
                      "nameKey": "CE.Projects.Name",
                      "seeded": true,
                      "moduleName": "CustomEntityManagement",
                      "schemaName": "projects",
                      "description": "A collaborative object set up to achieve one or more unique and specific business outcomes.",
                      "descriptionKey": "CE.Projects.Description",
                      "workflowType": "ef4e5bf9-7462-43af-b74f-72b61308629b",
                      "enabled": true,
                      "moduleScopes": [
                        "AA",
                        "AIG",
                        "DM"
                      ],
                      "settings": {
                        "enableWorkflow": true,
                        "enableWorkflowStageTracking": true,
                        "enableAudit": true,
                        "assessable": true,
                        "enableTask": true,
                        "enableRisk": true,
                        "enableDocument": true,
                        "enableControl": true,
                        "enableWebForm": false,
                        "enableComment": true
                      },
                      "auditFields": {
                        "createdDate": "2023-02-03T14:59:44.487Z",
                        "lastUpdatedDate": "2025-02-03T09:21:20.040Z"
                      }
                    }
                  }
                }
              }
            }
          },
          "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",
              "INTEGRATION"
            ]
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "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"
          }
        }
      },
      "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"
        ]
      },
      "EntityTypeInformation": {
        "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"
            ]
          },
          "description": {
            "description": "The description of the object type.",
            "type": "string",
            "example": "A third-party organization that provides goods or services to the company"
          },
          "descriptionKey": {
            "description": "The description key of the object type used for translation purposes.",
            "type": "string",
            "example": "entity.type.vendor.description"
          },
          "workflowType": {
            "description": "The type of workflow.",
            "type": "string",
            "example": "vendor_assessment"
          },
          "enabled": {
            "description": "This flag indicates whether the object type is enabled. ",
            "type": "boolean",
            "example": true,
            "default": "true"
          },
          "moduleScopes": {
            "description": "The product scopes of the object type.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": [
              "Inventory",
              "VRM",
              "Assessments",
              "IssueManagement"
            ],
            "enum": [
              "Inventory",
              "VRM",
              "Assessments",
              "IssueManagement",
              "CustomEntityManagement",
              "Control"
            ]
          },
          "settings": {
            "description": "The settings details of the object type.",
            "example": {
              "enableSearch": true,
              "enableQuickCreate": true,
              "enableExtendedAttributes": true,
              "enableDuplicateDetection": true,
              "workflowEnabled": true,
              "auditEnabled": true
            },
            "$ref": "#/components/schemas/EntityTypeSettingInformation"
          },
          "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"
          }
        },
        "example": {
          "id": "789e4567-e89b-12d3-a456-426614174123",
          "name": "Vendor",
          "nameKey": "entity.type.vendor",
          "displayName": "Vendor",
          "displayNameKey": "entity.type.vendor.display",
          "module": "VENDOR",
          "description": "A third-party organization that provides goods or services to the company",
          "descriptionKey": "entity.type.vendor.description",
          "workflowType": "vendor_assessment",
          "enabled": true,
          "moduleScopes": [
            "Inventory",
            "VRM",
            "Security"
          ],
          "settings": {
            "enableSearch": true,
            "enableQuickCreate": true,
            "enableExtendedAttributes": true,
            "enableDuplicateDetection": true,
            "workflowEnabled": true,
            "auditEnabled": true
          },
          "auditFields": {
            "createdBy": "admin@example.com",
            "createdTimestamp": "2023-01-15T10:30:45Z",
            "lastModifiedBy": "system@example.com",
            "lastModifiedTimestamp": "2025-03-22T14:15:22Z"
          }
        },
        "required": [
          "id",
          "name",
          "settings"
        ]
      },
      "EntityTypeSettingInformation": {
        "type": "object",
        "properties": {
          "enableWorkflow": {
            "description": "This flag indicates whether the workflow is enabled.",
            "type": "boolean",
            "example": true
          },
          "enableWorkflowStageTracking": {
            "description": "This flag indicates whether workflow stage tracking is enabled.",
            "type": "boolean",
            "example": true
          },
          "assessable": {
            "description": "This flag indicates whether the object type is assessable.",
            "type": "boolean",
            "example": false
          },
          "enableTask": {
            "description": "This flag indicates whether tasks are enabled.",
            "type": "boolean",
            "example": false
          },
          "enableRisk": {
            "description": "This flag indicates whether risks are enabled.",
            "type": "boolean",
            "example": false
          },
          "enableDocument": {
            "description": "This flag indicates whether documents are enabled.",
            "type": "boolean",
            "example": false
          },
          "enableControl": {
            "description": "This flag indicates whether controls are enabled.",
            "type": "boolean",
            "example": false
          },
          "enableWebForm": {
            "description": "This flag indicates whether web forms are enabled.",
            "type": "boolean",
            "example": false
          },
          "enableComment": {
            "description": "This flag indicates whether comments are enabled.",
            "type": "boolean",
            "example": false
          }
        },
        "required": [
          "assessable",
          "enableComment",
          "enableControl",
          "enableDocument",
          "enableRisk",
          "enableTask",
          "enableWebForm",
          "enableWorkflow",
          "enableWorkflowStageTracking"
        ]
      }
    },
    "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

* [Get List of Object Types](https://developer.onetrust.com/onetrust/reference/findallbytypeandcriteriausingpost.md)
* [Modify Custom Object Type by Name](https://developer.onetrust.com/onetrust/reference/updatecustomentitytypeusingpatch_1.md)
* [Enable Custom Object Type by Name](https://developer.onetrust.com/onetrust/reference/enabledcustomentitytypeusingput_1.md)
* [Get Object Type by ID](https://developer.onetrust.com/onetrust/reference/getentitytypeinformationusingget.md)
* [Modify Custom Object Type by ID](https://developer.onetrust.com/onetrust/reference/updatecustomentitytypeusingpatch.md)
* [Enable Custom Object Type by ID](https://developer.onetrust.com/onetrust/reference/enabledcustomentitytypeusingput.md)