Lookup properties list
| Parameter | Mandatory | Description | Examples | More Info |
|---|---|---|---|---|
| API | Yes | The API area | lookupsproperties.json | |
| General | Yes | Parameters described in overview | Authorization: Bearer <access_token> header — see Synergist API Authentication | Structure of an API call |
| Model Structure | Yes | Name of model required | modelstructure=lookupspropertieslist | Using data models |
| Company | Yes | The company number | company=16 |
Example request (OAuth 2.0):
Authorization: Bearer <access_token>
http://<SERVER>/jsonapi/lookupsproperties.json?&company=16&modelstructure=lookupspropertieslist&version=6
Example request (legacy username/password):
http://<SERVER>/jsonapi/lookupsproperties.json?&company=16&modelstructure=lookupspropertieslist&version=6&user=<username>&password=<password>
or
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 129,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"synapiversion": 3.8,
"data": [
{
"lookupspropertiesUuid": "41B615A673484F77A31EEEB07746FD54",
"lookupspropertiesTimestampModified": 1385820617,
"lookupspropertiesRecordVersionNumber": 0,
"lookupspropertiesUdfLabel": "* Activity Types in Activities",
"lookupspropertiesTableNum": 81,
"lookupspropertiesCompany": 16,
"lookupspropertiesUdfField": 0,
"lookupspropertiesOriginalName": "* NoteType in Notes *",
"lookupspropertiesUdfFieldType": 0,
"lookupspropertiesUdfDisplayOrder": "",
"lookupspropertiesUdfMandatory": false,
"lookupspropertiesInactive": false
},
{
"lookupspropertiesUuid": "E8194E4FEE208E4AAC3D89E501284971",
"lookupspropertiesTimestampModified": 1643022760,
"lookupspropertiesRecordVersionNumber": 4,
"lookupspropertiesUdfLabel": "Client budget",
"lookupspropertiesTableNum": 81,
"lookupspropertiesCompany": 16,
"lookupspropertiesUdfField": 590,
"lookupspropertiesOriginalName": "Activities 1",
"lookupspropertiesUdfFieldType": 1,
"lookupspropertiesUdfDisplayOrder": "",
"lookupspropertiesUdfMandatory": false,
"lookupspropertiesInactive": false
}
]
}