Returns the types of record the token owner may read, with their fields. Use it to learn the short
keys a request accepts. A type the roles do not allow is missing, and so is a field the roles hide.
Scope crm:read. Read only: types, fields and roles are changed in the CRM app.
Response
array
required
Show properties
string
required
The type, such as company, person, opportunity or the key of a custom type.
string
required
The name of the type.
string
required
STANDARD or CUSTOM.
object
required
create, update, delete and export: what the token owner may do with this type.
object | null
required
{ "isReadOnly": boolean }, or null when the roles hide the owner.
array
required
The kinds of contact point (EMAIL, PHONE, DOMAIN) the roles show, each with isReadOnly.
array
required
Each field has key, label, type, section, isRequired, isReadOnly and options (the choices of a selection field, the stages of a pipeline in order).
array
required
Each relation has key, fromTypeKey, toTypeKey, cardinality and maxPerFrom. Set one with links on a record.