objects

Get %alias and field information

Changed on

Get information about an existing %alias fields

get/objects/meta

Request

  • Base URL
    https://api.ontraport.com/1
  • Auth
    none declared

Query parameters

format'byId' | 'byName'

Choose to get the list indexed by Object class name or integer ID.

sectionsboolean

Boolean flag to additionally return the field layout for each object. Adds a tabs object keyed by 0-based display position, each tab {id, name, sections}, where sections is keyed the same way and each section is {id, name, description}. Each field also gains a section id pointing at its section. description is only present when set. Iterate keys in numeric order to get the layout as the admin arranged it; the keys are always a contiguous 0-based sequence. Use each entry's id with /objects/fieldeditor to modify it.

objectIDinteger

Object Type ID.

Response

Successful object query

codeinteger required
dataobject required
account_idinteger required

Changes