Lookups list

Lookups list

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API arealookups.json
GeneralYesParameters described in overviewAuthorization: Bearer <access_token> header — see Synergist API AuthenticationStructure of an API call
Model StructureYesName of model requiredmodelstructure=lookupslistUsing data models
CompanyYesThe company numbercompany=16
Lookup peroprties UUIDYesThe custom field UUIDlookupspropertiesUUID=37E5E6EF45C94AEFA7C273BE28A28497

Example request (OAuth 2.0):

list of lookup validation list items
Authorization: Bearer <access_token>
http://<SERVER>/jsonapi/lookups.json?&modelstructure=lookupslist&lookupspropertiesUUID=37E5E6EF45C94AEFA7C273BE28A28497&company=16&version=6

Example request (legacy username/password):

http://<SERVER>/jsonapi/lookups.json?&modelstructure=lookupslist&lookupspropertiesUUID=37E5E6EF45C94AEFA7C273BE28A28497&company=16&version=6&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.9,
  "data": [
    {
      "lookupsUuid": "AD8561E351DD4B3FA1176E1FC5DECD77",
      "lookupsTimestampModified": 1642510496,
      "lookupsRecordVersionNumber": 1,
      "lookupsLookupsPropertiesUuid": "37E5E6EF45C94AEFA7C273BE28A28497",
      "lookupsLookupValue": "Category 1",
      "lookupsContextValue": "0/DOC",
      "lookupsInactive": false,
      "lookupsLookupOrder": 0
    },
    {
      "lookupsUuid": "345DEBED1DC563439BE6AE374FBDA976",
      "lookupsTimestampModified": 1642510507,
      "lookupsRecordVersionNumber": 1,
      "lookupsLookupsPropertiesUuid": "37E5E6EF45C94AEFA7C273BE28A28497",
      "lookupsLookupValue": "Meeting",
      "lookupsContextValue": "16/MEET",
      "lookupsInactive": false,
      "lookupsLookupOrder": 0
    }
  ]
}