Campaign List

Parameter	Mandatory	Description	Examples	More Info
API	Yes	The API area	campaigns.json
General	Yes	Parameters described in overview	see overview	Structure of an API call
Model Structure	Yes	Name of model required	modelstructure=campaignslist	Using data models
View	No	Stored filter applied		Using views
Sort	No	Change the view's default sort order	sort=CREATED	Sorting
Filters	No	Filter by a key field		Filters
Company	Yes	The company number	company=1
Project	No	Project number	project=123
Client	No	Client ID	client=1/A001

Example request (OAuth 2.0):

Authorization: Bearer <access_token>
https://<SERVER>/jsonapi/campaigns.json?&version=6&modelstructure=campaignslist&company=1&project=123

Example request (legacy username/password):

https://<SERVER>/jsonapi/campaigns.json?&version=6&modelstructure=campaignslist&company=1&project=123&user=<username>&password=<password>

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 2,
  "totalpages": 1,
  "responsemessage": "",
  "pagerows": 0,
  "pagenumber": 1,
  "success": true,
  "synversion": "15.000.0017",
  "synapiversion": 6,
  "data": [
    {
      "campaignUuid": "4E779EB9F04A62479567BF67A925BB9A",
      "campaignTimeStampModified": 1752836928,
      "campaignRecordVersionNumber": 1,
      "campaignNo": 429,
      "campaignName": "Campaign 1",
      "campaignClientCode": "",
      "campaignClientName": "",
      "campaignProjectNo": 123,
      "campaignProjectName": ""
    },
    {
      "campaignUuid": "78DA927F2A81924697DDFA604174F73F",
      "campaignTimeStampModified": 1753363412,
      "campaignRecordVersionNumber": 0,
      "campaignNo": 430,
      "campaignName": "Test Created 22-07-25",
      "campaignClientCode": "",
      "campaignClientName": "",
      "campaignProjectNo": 123,
      "campaignProjectName": ""
    }
  ]
}