Key field filters

Key field filters

When requesting data you can optionally pass additional parameters that will filter the data returned by a key field.

ParameterDescriptionExamples
Parameters described in overviewuser=user&password=user&version=3.8
CompanyThe company contextcompany=1
Record IDID of a specific record to use as a filterclient=1/F667
ResponseReturned dataA JSON string containing the data

In this example a list of activities is returned but is filtered to only return activities for a specific client

http://<SERVER>/jsonapi/activities.json?company=1&version=3.8&user=user&password=user&style=modeldata&modelstructure=activitylist&client=1/F667

To poll for created/modified records..

http://<SERVER>/jsonapi/activities.json?company=1&version=3.8&user=user&password=user&style=modeldata&modelstructure=activitylist&timestampoffsetfrom=-900


The list of key fields that can be used as filters include:
job=
jobphase=
client/client code=
clientcontact=
supplier=
suppliercontact=
workflow=
search=
uuid=
timestampfrom= (e.g. timestampfrom=1544610321)
timestampto=
timestampoffsetfrom (e.g. timestampoffsetfrom =-900 any records modified in the past 15 mins)
timestampoffsetto
Activity/Activityid=
resource=
datefrom=
dateto=