Retrieve all the campaigns

get

https://api.gainfully.com/v1.0/campaigns/

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

filter__campaign_type

string

Filter the campaigns by the type. Valid values are organization and client.

filter__created_at__gt

integer

Filter the campaigns created after the specified timestamp.

filter__created_at__lt

number

Filter the campaigns created before the specified timestamp.

filter__scheduled_at__gt

number

Filter the campaigns scheduled to be sent out after the specified timestamp.

filter__scheduled_at__lt

number

Filter the campaigns scheduled to be sent out before the specified timestamp.

filter__sender_id

number

Filter the campaigns by the sender's id.

filter__status

string

enum

Filter the campaigns by the status.

Allowed:

filter__template_id

number

Filter the campaign by the id of the email template.

ordering

string

enum

Sort the results against the specified fields. By default, the results are sorted by id. To sort the results in the reverse order of a field, the field name must be preceded with the - sign. To sort the results by multiple fields, the field names must be separated by commas. Please note the order for status is in_progress < paused < draft < scheduled < canceled < completed.

Allowed:

fields

string

Specify which fields to retrieve.

offset

number

Starting position of the query in relation to the complete set of unpaginated items.

limit

integer

Number of objects to retrieve in the response. By default, the value is the maximum, which is 100.

Response

200Success!