Describe an entity
Use this REST resource to describe an entity. Provide the name of the entity within the request path and use the GET HTTP method to receive the entity's metadata.
curl GET 'https://{domain}/api/3.0/entity/{entity_name}/metadata'
-H 'Content-Type: application/json'
-H 'Accept: application/json'
-H 'Authorization: Bearer {access_token}'
Request
entity_name string Required
Name of entity to be described. This value should be a valid entity API Name.
Note: The response may vary based on the permission of the requesting user. If a user does not have access to an entity or some of its fields, that information will not appear in the response.
Example
curl GET 'https://{domain}/api/3.0/entity/account/metadata'
-H 'Content-Type: application/json'
-H 'Accept: application/json'
-H 'Authorization: Bearer {access_token}'
Successful Response
HTTP 200 OK
{
"Id": "7NS0000000000bg0001",
"Name": "Account",
"Label": "Account",
"PluralLabel": "Accounts",
"StartsWithVowel": false,
"KeyPrefix": "002",
"DbSchema": "standard",
"EntityType": "Object",
"TrackFeeds": true,
"AllowReports": true,
"TrackActivities": true,
"Triggerable": true,
"Automationable": true,
"IsHidden": false,
"IsCustom": true,
"IsPermissionable": true,
"Fields": [ ... ],
"Relationships": [ ... ]
}
Failed Response
HTTP 404 - Not Found
{
"message": "Invalid entity: 'contact2'",
"success": false
}