Describe Custom Objects
Returns metadata regarding a given custom object.
Parameters
Path 1
Responses
200 OK ResponseOfObjectMetaData
errors array of Error required
Array of errors that occurred if the request was unsuccessful
Model Error
code string required Error code of the error. See full list of error codes here
message string required Message describing the cause of the error
moreResult boolean Boolean indicating if there are more results in subsequent pages
nextPageToken string Paging token given if the result set exceeded the allowed batch size
requestId string required Id of the request made
result array of ObjectMetaData required
Array of results for individual records in the operation, may be empty
Model ObjectMetaData
createdAt string (date-time) required Datetime when the object type was created
dedupeFields array of string required List of dedupe fields. Arrays with multiple members are compound keys
description string required Description of the object type
displayName string required UI display-name of the object type
pluralName string required UI plural-name of the custom object type
fields array of ObjectField required
List of fields available on the object type
Model ObjectField
dataType string Datatype of the field
displayName string UI display-name of the field
length integer (int32) Max length of the field. Only applicable to text, string, and text area.
name string Name of the field
updateable boolean Whether the field is updateable
crmManaged boolean Whether the field is managed by CRM (native sync)
idField string required Primary id key of the object type
apiName string required Name of the object type
relationships array of ObjectRelation required
List of relationships which the object has
Model ObjectRelation
field string required API Name of link field
relatedTo RelatedObject required
Object to which the field is linked
Model RelatedObject
result › relationships › relatedTo
field string required Name of link field (within link object)
name string required Name of the link object
type string required Type of the relationship field
searchableFields array of array required List of fields valid for use as a filter type in a query
updatedAt string (date-time) required Datetime when the object type was most recently updated
state string Approval state of object type
Values draft approved approvedWithDraft
version string required Version of object type that is returned in response
Values draft approved
success boolean required Whether the request succeeded
warnings array of Warning required
Array of warnings given for the operation
Model Warning
code integer (int32) required Integer code of the warning
message string required Message describing the warning
Generated example
{
"errors": [
{
"code": "string",
"message": "string"
}
],
"moreResult": false,
"nextPageToken": "example-token",
"requestId": "123",
"result": [
{
"createdAt": "2026-01-15T10:30:00Z",
"dedupeFields": [
"string"
],
"description": "string",
"displayName": "Example name",
"pluralName": "Example name",
"fields": [
{
"dataType": "string",
"displayName": "Example name",
"length": 123,
"name": "Example name",
"updateable": false,
"crmManaged": false
}
],
"idField": "string",
"apiName": "Example name",
"relationships": [
{
"field": "string",
"relatedTo": {
"field": "string",
"name": "Example name"
},
"type": "string"
}
],
"searchableFields": [
[
"string"
]
],
"updatedAt": "2026-01-15T10:30:00Z",
"state": "draft",
"version": "draft"
}
],
"success": false,
"warnings": [
{
"code": 123,
"message": "string"
}
]
}Referenced models
Generated from swagger-mapi.json. Generated examples are inferred from the schema; they are illustrative and may not be valid production payloads.