Get lookup items for a parent
Lookups - filtered by parent
| Parameter | Mandatory | Description | Examples | More Info |
|---|---|---|---|---|
| API | Yes | The API area | lookupsproperties.json | |
| Action | Yes | The action to perform | action=lookups | |
| General | Yes | Parameters described in overview | Authorization: Bearer <access_token> header — see Synergist API Authentication | Structure of an API call |
| Lookup properties UUID | Yes | The custom field UUID | UUID=5D9BF44924733C4C87D1831FE90D4DAC | |
| Filter | Yes | The parent filter | parent=club |
Example request (OAuth 2.0):
Authorization: Bearer <access_token>
http://<SERVER>/jsonapi/lookupsproperties.json?&UUID=5D9BF44924733C4C87D1831FE90D4DAC&version=6&action=lookups&parent=club
Example request (legacy username/password):
http://<SERVER>/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"
}
]
}