Describe an entity field
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/{field_name}'
-H 'Content-Type: application/json'
-H 'Accept: application/json'
-H 'Authorization: Bearer {access_token}'
Request
entity_name string Required
Name of the entity the field belongs to. This value should be a valid entity API Name.
field_name string Required
Name/Record ID of a valid entity field which belongs to the selected entity.
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
Describe the Account entity's Name field:
curl GET 'https://{portal-domain}/api/3.0/entity/account/metadata/name'
-H 'Content-Type: application/json'
-H 'Accept: application/json'
-H 'Authorization: Bearer {access_token}'
Successful Response
HTTP 200 OK
{
"Id": "7NX0000000000Un0000",
"Name": "Name",
"Label": "Name",
"FieldType": "Text",
"IsKey": false,
"IsSearchable": true,
"IsReadable": true,
"IsReference": false,
"IsAuditField": false,
"IsReadOnly": false,
"IsRequired": false,
"IsExternalId": false,
"IsCalculated": false,
"IsNameField": true,
"IsSystemField": false,
"IsCustomField": false,
"ReferenceType": "None",
"IsFilterable": true,
"IsAuditable": false,
"IsAudited": false,
"IsSortable": true,
"IsUnique": false,
"IsHtml": false,
"Length": 120,
"Precision": 0,
"IsMapped": true,
"TimeDisplayOption": "Minutes",
"IsDepedentPicklist": false,
"DependentPicklists": {},
"Validations": []
}
Failed Response
HTTP 404 - Not Found
{
"message": "Field not found.",
"success": false
}