Campaigns

List campaigns

Returns a list of all campaigns the user has access to

get/campaigns

Request

Base URL: http://bonzo.site/api/v3
URL: http://bonzo.site/api/v3/campaigns
Auth: HTTP bearer

Query parameters

searchstring

Example:Campaign name

Search by name

active_onlyboolean

type'consequtive' | 'date_based'

Example:date_based

sort'name' | 'messages' | 'prospects' | 'status'

Example:name

order'desc' | 'asc'

Example:desc

per_pageinteger

pageinteger

no_paginateboolean

Response

Success

Example response

{
  "data": [
    {
      "name": "Campaign name",
      "lead_zapier_uuid": "012a345b-1abc-1234-1a2b-1223456ab789c",
      "created_at": "2022-01-01T01:00:00.000000Z",
      "updated_at": "2022-01-01T01:00:00.000000Z",
      "sequence": {
        "name": "Sequence name",
        "campaign_id": "1",
        "enabled": true,
        "enable_date": "2022-01-01T01:00:00.000000Z",
        "type": "day_based",
        "prospect_zapier_uuid": "012a345b-1abc-1234-1a2b-1223456ab789c",
        "description": "Sequence description.",
        "start_campaign": "2022-01-01T01:00:00.000000Z",
        "cutoff_start": "09:00:00",
        "cutoff_stop": "18:00:00",
        "created_at": "2022-01-01T01:00:00.000000Z",
        "updated_at": "2022-01-01T01:00:00.000000Z"
      }
    }
  ],
  "links": {
    "first": "https://example.com?page=1",
    "last": "https://example.com?page=3",
    "next": "https://example.com?page=2"
  },
  "meta": {
    "links": [
      {
        "url": null,
        "label": "&laquo; Previous",
        "active": false
      },
      {
        "url": "https://example.com?page=1",
        "label": 1,
        "active": true
      },
      {
        "url": "https://example.com?page=2",
        "label": 2,
        "active": false
      },
      {
        "url": "https://example.com?page=2",
        "label": "Next &raquo;",
        "active": false
      }
    ],
    "path": "https://example.com"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.