List all advertisers

Returns all non-deleted advertisers for the authenticated user's account as a JSON array.

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/advertisers.do

Returns all non-deleted advertisers for the authenticated user's account as a JSON array. Each advertiser object includes: id, name, active, category, and description (if set). Requires VIEW permission on CAMPAIGNS at ALL level (returns all advertisers) or SHARED level (returns only advertisers shared with the requester). Results can be optionally filtered by one or more advertising category IDs passed as query parameters, and by any on/off setting or relation flag (filter[...]); they are ordered by id, paged with offset and limit, and trimmed to the fields named in fields. If the user lacks both ALL and SHARED VIEW permissions, a 403 error is returned.

Query Params

advertisingCategories array<integer>

Optional array of advertising category IDs to filter the results. Only advertisers belonging to at least one of the specified categories will be returned. Pass multiple values as repeated query parameters, e.g. advertisingCategories=1&advertisingCategories=5.

5

offset integer

Pagination offset over advertisers ordered by id (zero-based)

0

limit integer

Maximum number of advertisers to return; omit for all

100

fields array<string>

Return only these fields of each entity, comma-separated; id is always kept. A requested field no returned row carries is named in the X-Ignored-Fields response header

id,name,active

filter object

Keep only entities matching every key, e.g. filter[cpaOptimization]=true&filter[hasLimit]=true. Keys are the entity's on/off settings (active, enableTargeting, cpaOptimization, alwaysRedirect, ...) and a has<Relation> flag for each setting kept in rows of its own (hasLimit, hasPricing, hasFrequencyCapping, hasTrackingCode, hasPriceAdjustmentRules, hasLabels, hasBanners, ...), true when the relation holds a row; hasCapping, hasLimits and hasTargetingRules group the relations of their kind. An unknown key is a 400 that lists every valid key for the list.

{"hasLimits": "true"}

Responses

200

Array of advertiser objects

400

Bad request — invalid or missing parameters

401

Unauthorized — authentication failed or missing credentials

403

Insufficient permissions

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/advertisers.do?advertisingCategories=5&offset=0&limit=100' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/advertisers.do?advertisingCategories=5&offset=0&limit=100", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/advertisers.do?advertisingCategories=5&offset=0&limit=100', {
  method: 'GET',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
});

console.log(await response.json());

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/advertisers.do?advertisingCategories=5&offset=0&limit=100"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

C# Request

using var client = new HttpClient();

var request = new HttpRequestMessage(new HttpMethod("GET"), "https://YOUR-NETWORK-DOMAIN/rest-api/advertisers.do?advertisingCategories=5&offset=0&limit=100");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Go Request

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/advertisers.do?advertisingCategories=5&offset=0&limit=100", nil)
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}

PHP Request

<?php
$ch = curl_init("https://YOUR-NETWORK-DOMAIN/rest-api/advertisers.do?advertisingCategories=5&offset=0&limit=100");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY"]);

echo curl_exec($ch);
curl_close($ch);

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/advertisers.do?advertisingCategories=5&offset=0&limit=100")
request = Net::HTTP::Get.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.body