Lookups - filtered by parent

Get lookup items for a parent

Lookups - filtered by parent

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API arealookupsproperties.json
ActionYesThe action to performaction=lookups
GeneralYesParameters described in overviewAuthorization: Bearer <access_token> header — see Synergist API AuthenticationStructure of an API call
Lookup properties UUIDYesThe custom field UUIDUUID=5D9BF44924733C4C87D1831FE90D4DAC
FilterYesThe parent filterparent=club

Example request (OAuth 2.0):

Authorization: Bearer <access_token>
http://&lt;SERVER&gt;/jsonapi/lookupsproperties.json?&UUID=5D9BF44924733C4C87D1831FE90D4DAC&version=6&action=lookups&parent=club

Example request (legacy username/password):

http://&lt;SERVER&gt;/jsonapi/lookupsproperties.json?&UUID=5D9BF44924733C4C87D1831FE90D4DAC&version=6&action=lookups&parent=club&user=<username>&password=<password>

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 2,
  "totalpages": 1,
  "responsemessage": "",
  "pagerows": 0,
  "pagenumber": 1,
  "success": true,
  "synapiversion": 3.8,
  "data": [
    {
      "array_customlookup": "Guides"
    },
    {
      "array_customlookup": "Scouts"
    }
  ]
}