• iOS
  • Android
  • Windows
  • Cordova
  • Web
  • Unity
  • Adobe Air
  • Dashboard
  • API
  • Guides
  • FAQ
  • API > Campaigns API

    GET - List campaigns

    The list endpoint allows you to get a campaign list.

    Request structure

    Route

    The campaigns API exposes a GET endpoint at: https://api.batch.com/1.1/BATCH_API_KEY/campaigns/list

    Here are examples of valid cURL, PHP or Python requests syntax:

    curl -X GET "https://api.batch.com/1.1/BATCH_API_KEY/campaigns/list" \
    -H "Content-Type: application/json" \
    -H "X-Authorization: BATCH_REST_API_KEY"
    
    use GuzzleHttp\Client;
    $client = new Client();
    $response = $client->request("GET", "https://api.batch.com/1.1/BATCH_API_KEY/campaigns/list", [
        "headers" => [
            "Content-Type" => "application/json",
            "X-Authorization" => "BATCH_REST_API_KEY"
        ]
    ]);
    
    import requests, json
    response = requests.request("GET", "https://api.batch.com/1.1/BATCH_API_KEY/campaigns/list", 
        headers={
            'Content-Type': 'application/json'
            'X-Authorization': 'BATCH_REST_API_KEY'
        }
    )
    

    Get parameters

    IdDescription
    fromInteger - Optional, Default : 0
    Value used for pagination : it indicates the offset of the first campaign to be returned. Campaigns are ordered by creation date (from the most recent to the oldest).
    E.g."/campaigns/list?from=10"
    limitInteger - Optional, Default : 10, Max : 100
    Value that indicates the number of campaigns to be returned per API call.
    E.g."/campaigns/list?limit=20"
    liveBoolean - Optional
    Allows to filter according to the campaign LIVE state. `true` will only return running or completed campaigns, whereas `false` will only return stopped and draft campaigns.
    E.g."/campaigns/list?live=true"
    from_apiBoolean - Optional
    Allows to filter according to the way that campaigns have been created. `true` will only return campaigns created with the API. `false` value will only return campaigns created from the dashboard. If you want all campaigns, omit this parameter.
    E.g."/campaigns/list?from_api=false"

    Here is an example of a valid CURL CLI request, which would return 5 live (running or completed) campaigns created from the api, starting from the 10th campaign :

    curl -H "Content-Type: application/json" -H "X-Authorization: BATCH_REST_API_KEY" -X GET 
    "https://api.batch.com/1.1/BATCH_API_KEY/campaigns/list?from=10&limit=5&live=true&from_api=true"
    

    Headers

    In order to authenticate with the API, you need to provide your company REST API Key as the value of the X-Authorization header.

    Responses

    Success

    If the GET to the API endpoint is successfull you will receive an HTTP 200 confirmation and information on your campaigns. The endpoint only returns basic information about campaigns. If you need more information about a campaign, use the GET endpoint using the campaign_token.

    [
        {
            "campaign_token": "a0082dc6860938a26280bd3ba927303b",
            "from_api": false,
            "dev_only": false,
            "created_date": "2017-03-02T09:43:17",
            "name": "Test Campaign 1",
            "live": true,
            "push_time": "2017-07-06T14:09:18"
        },
        {
            "campaign_token": "a0082dc6860938a26280bd3ba927303a",
            "from_api": false,
            "dev_only": true,
            "created_date": "2017-03-02T09:43:17",
            "name": "Test Campaign 2",
            "live": false,
            "deeplink": "deeplink",
            "custom_payload": "{\"foo\" : \"bar\"}",
            "local_push_time": "2017-03-03T13:10:19",
            "recurrence": {
                "end_date": "2017-07-22T23:59:59",
                "repeat_unit": "WEEKLY",
                "repeat_frequency": 2
            },
            "query": {
                "$or": [
                    {
                        "isNear(45.7583907,4.8347867,30km)": true
                    },
                    {
                        "countForLabel(e.label_data, 'example')": 0
                    }
                ]
            },
            "capping": 2
        }
    ]
    

    Failure

    If the GET data does not meet the API requirements you will receive an actionable error message. Contact us at support@batch.com if you need further support.

    • MALFORMED_PARAMETER (Http status code: 400, Error code: 31)
    • AUTHENTICATION_INVALID (Http status code: 401, Error code: 10)
    • ROUTE_NOT_FOUND (Http status code: 404, Error code: 20)
    • SERVER_ERROR (Http status code: 500, Error code: 0)