latestSwagger 2.02026-08-109034173.2 KB

edcd035d71f5

objects

This will get a list of %plural

Get a list of %plural using various search parameters.

get/objects

Query parameters

objectIDinteger required

Object Type ID.

idsinteger[]

Array of Object IDs as comma-delimited list.

startinteger

Return results starting at this offset

rangeinteger

Number of results to return (maximum=50)

sortstring

Field used to sort results

sortDir'asc' | 'desc'

Sort direction, must be used in conjunction with <b>sort</b> parameter.

searchstring

Search Objects for this string

searchNotesboolean

Boolean flag to additionally search Object Notes for the Search term given in Search parameter

group_idinteger

The Group ID as an integer

externsstring

External fields to include in results

listFieldsstring[]

Array of fields to return in response as comma-delimited list.

user_readable'RAW' | 'CSV'

'CSV' used to return values that are in plain english rather than an id, particularly useful for dropdown field values. 'RAW' returns raw data.

countboolean

Boolean flag to return a count of the entire collection.

Response

Successful object query

codeinteger required
dataobject required
account_idinteger required