List broadcast-campaigns

​
Query Parameters
  • include
    Type: string

    Comma-separated. Allowed: template, template.files, audience

  • filter[search]
    Type: string
  • sort
    Type: string

    Allowed: name, created_at

  • page[number]
    Type: integer

    Integer numbers.

  • page[size]
    Type: integer

    Integer numbers.

Responses
  • application/vnd.api+json
  • 401

    Unauthorized

  • 403

    Forbidden

Request Example for get/api/v1/broadcast-campaigns
curl 'https://b.anny.co/api/v1/broadcast-campaigns?include=&filter%5Bsearch%5D=&sort=&page%5Bnumber%5D=1&page%5Bsize%5D=1'

{
  "data": [
    {
      "id": "string",
      "type": "broadcast-campaigns",
      "attributes": {
        "name": "string",
        "scheduled_at": null,
        "status": "draft",
        "total_count": 1,
        "failed_count": 1,
        "sent_count": 1,
        "recurring": true,
        "cron": "string",
        "created_at": "string"
      },
      "links": {
        "self": "https://example.com"
      },
      "relationships": {
        "template": {
          "data": {
            "type": "string",
            "id": "string"
          },
          "links": {
            "self": "https://example.com"
          }
        },
        "audience": {
          "data": {
            "type": "string",
            "id": "string"
          },
          "links": {
            "self": "https://example.com"
          }
        }
      }
    }
  ],
  "meta": {},
  "links": {}
}

OK