Campaign List

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areacampaigns.json
GeneralYesParameters described in overviewsee overviewStructure of an API call
Model StructureYesName of model requiredmodelstructure=campaignslistUsing data models
ViewNoStored filter appliedUsing views
SortNoChange the view's default sort ordersort=CREATEDSorting
FiltersNoFilter by a key fieldFilters
CompanyYesThe company numbercompany=1
ProjectNoProject numberproject=123
ClientNoClient IDclient=1/A001

Example request:

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

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": ""
    }
  ]
}