customObjectGetFieldEntities

View as Markdown

Get relationship entities for a custom object field.

Returns the valid entities (people, assets, custom objects, tags) for a RELATIONSHIP or ENTITY_REFERENCE field on a custom object type.

Parameters

NameTypeRequiredDescription
referenceKeystringYesThe referenceKey of the relationship/entity field (from getObjectTypeFormFields response)
entity_idintegerYesThe object type ID (required to scope entities to the correct type)
search_keystringNoSearch entities by name, email, or label
pageintegerNoDefault: 1.
page_sizeintegerNoDefault: 25.