Campaign List

Get a list of campaigns

HTTP Request

[GET] /api/v6/campaigns

Query Parameters

Fields

Fields	Type	Description
id	integer	Identifier
campaign_name	string	Campaign name
token_api	string	Token
description	string	Description
start_date	timestamp	Start date
end_date	timestamp	End date

Filtering

Fields	Support	Type	Description
id	eq,in	integer	Identifier
valid	is,in	integer	Valid or not

Sort

| Sort (field) | Direction |
|:-------------|-----------|
| id | asc,desc |
| updated_at | asc,desc |\

Limit & Offset

	Type	Description
Limit	integer	Number of records to retrieve
Offset	integer	Number of records to skip

Example

HTTP Request

GET api/v6/campaigns?fields=campaign_name&filtering[id]=4&limit=1&offset=0 HTTP/1.1
Host: example.getflycrm.com
Content-Type: application/json

Status

200 OK

Response

{
  "data": [
    {
      "id": 4,
      "campaign_name": "TEST CAMPAIGN API"
    }
  ],
  "has_more": false,
  "offset": 0,
  "limited": 1
}