Skip to main content
GET
/
campaigns
/
List campaigns
curl --request GET \
  --url https://api.journeybee.io/v1/campaigns/ \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "uuid": "<string>",
      "title": "<string>",
      "type": "<string>",
      "description": "<string>",
      "status": "<string>",
      "completed": true,
      "lead_sharing_enabled": true,
      "start_date": "<string>",
      "end_date": "<string>",
      "scheduled_at": "<string>",
      "timezone": "<string>",
      "venue": "<string>",
      "physical_address": "<string>",
      "partner_type_referral": true,
      "partner_type_reseller": true,
      "partner_type_distributor": true,
      "enabled_modules": [],
      "email_template": {
        "uuid": "<string>",
        "name": "<string>",
        "subject": "<string>"
      },
      "tags": [
        {
          "uuid": "<string>",
          "label": "<string>"
        }
      ],
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ],
  "pagination": {
    "page": 123,
    "per_page": 123,
    "total": 123,
    "total_pages": 123
  }
}

Authorizations

Authorization
string
header
required

API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

Query Parameters

page
integer
default:1
Required range: 1 <= x <= 9007199254740991
per_page
integer
default:25
Required range: 1 <= x <= 100
Maximum string length: 200
status
string
Maximum string length: 50
type
string
Maximum string length: 100
include_archived
boolean
default:false

Response

200 - application/json

Default Response

data
object[]
required
pagination
object
required