v1

latestOpenAPI 3.0.02026-08-062438369.6 KB
Campaigns

List / find Campaigns

Returns a paginated list of all campaigns belonging to your organization family. Use this endpoint to sync campaign records into an external system or to look up campaigns by name. You can scope results to specific organizations using the org_slug filter, or narrow by creation and update timestamps to retrieve only recently changed records.

get/campaigns

Query parameters

pageinteger

Page number (if paging results).

org_slugstring

One or more org slugs (comma separated) campaigns should belong to.

name_likestring

The campaign name, or part of a name, to search for.

created_beforestring date-time

Date the campaign was created on or before.

created_afterstring date-time

Date the campaign was created on or after

updated_beforestring date-time

Date the campaign was updated on or before.

updated_afterstring date-time

Date the campaign was updated on or after

Response

Returns the paginated list of campaigns for your organization family. The response includes pagination links and meta fields to navigate additional pages.

Example response

{
  "data": [
    {
      "type": "campaign",
      "id": "1",
      "campaign_name": "Together",
      "description": "Example description.",
      "url": "http://app.vomo.org/initiative/together",
      "organization": "VOMO",
      "organization_id": 1,
      "organization_slug": "vomo",
      "logo_url": "https://s3.amazonaws.com/awakenmycity/j2/7Z/r4-s.jpg",
      "updated_at": "2016-03-07T07:49:41+00:00",
      "created_at": "2016-03-07T07:49:41+00:00"
    }
  ]
}