Get list of programs

Use this endpoint to receive the list of programs available in the Takeads catalog.

When querying a list of programs, the detailed information on each program is also provided in the response.

If you receive an empty list of programs, but the next value in the response is not null — request the following page of the programs list, using the next query parameter with the next value from the received response.

You can test this API endpoint and inspect the possible responses using Swagger UI.

Request

URL: https://api.takeads.com/v1/product/monetize-api/v2/program

Method: GET

Request headers

Query parameters

Specify the query parameters to get particular programs or paginate the response. This endpoint has no required parameters.

If no query parameters are specified, the list with up to 500 first programs is returned.

The following table describes query parameters that you can use in the request.

Request examples

• 
  curl --location --request GET --header 'Authorization: Bearer <Public Key>' \
  
  'https://api.takeads.com/v1/product/monetize-api/v2/
  program?updatedAtFrom=2022-01-01T00%3A00%3A00.000Z&updatedAtTo=2022-05-01T00%3A00%3A00.000Z&programStatus=ACTIVE&limit=100&next=64b56b75-83df-43e3-855b-28129bdd7b46'
  

• const myHeaders = new Headers();
  
  myHeaders.append("Authorization", "Bearer <Public Key>");
  
  
  const requestOptions = {
  
    method: 'GET',
  
    headers: myHeaders,
  
    redirect: 'follow'
  
  };
  
  
  fetch("https://api.takeads.com/v1/product/monetize-api/v2/program?updatedAtFrom=2022-01-01T00%3A00%3A00.000Z&updatedAtTo=2022-05-01T00%3A00%3A00.000Z&programStatus=ACTIVE&limit=100&next=64b56b75-83df-43e3-855b-28129bdd7b46", requestOptions)
  
    .then(response => response.text())
  
    .then(result => console.log(result))
  
    .catch(error => console.log('error', error));
  

• <?php
  
  
  $curl = curl_init();
  
  
  curl_setopt_array($curl, array(
  
   CURLOPT_URL => 'https://api.takeads.com/v1/product/monetize-api/v2/program?updatedAtFrom=2022-01-01T00%253A00%253A00.000Z&updatedAtTo=2022-05-01T00%253A00%253A00.000Z&programStatus=ACTIVE&limit=100&next=64b56b75-83df-43e3-855b-28129bdd7b46',
  
    CURLOPT_RETURNTRANSFER => true,
  
    CURLOPT_ENCODING => '',
  
    CURLOPT_MAXREDIRS => 10,
  
    CURLOPT_TIMEOUT => 0,
  
    CURLOPT_FOLLOWLOCATION => true,
  
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  
    CURLOPT_CUSTOMREQUEST => 'GET',
  
    CURLOPT_HTTPHEADER => array(
  
      'Authorization: Bearer <Public Key>'
  
    ),
  
  ));
  
  
  
  $response = curl_exec($curl);
  
  
  curl_close($curl);
  
  echo $response;
  
  

• import http.client
  
  
  conn = http.client.HTTPSConnection("api.takeads.com")
  
  payload = ''
  
  headers = {
  
    'Authorization': 'Bearer <Public Key>'
  
  }
  
  conn.request("GET", "/v1/product/monetize-api/v2/program?updatedAtFrom=2022-01-01T00%253A00%253A00.000Z&updatedAtTo=2022-05-01T00%253A00%253A00.000Z&programStatus=ACTIVE&limit=100&next=64b56b75-83df-43e3-855b-28129bdd7b46", payload, headers)
  
  res = conn.getresponse()
  
  data = res.read()
  
  print(data.decode("utf-8"))
  

Response

If the request was successfully processed by the server, an HTTP response with status code 200 is returned.

The response payload is a JSON object that contains a meta object with metadata, and a data array with information about retrieved programs. Each item of the array is an object with the program's details.

The following table describes the response metadata.

The following table describes the response properties from the data array.

Example value

{

	"meta": {

		"next": 64b56b75-83df-43e3-855b-28129bdd7b46,

		"limit": 500

	},

	"data": [

		{

			"id": "7fc4b9f7-ee66-41e0-b6ca-38087aae1188",

			"name": "Example CH",

			"pricingModel": "CPA",

                        "programStatus": "ACTIVE",

			"avgCommission": 2.72,

                        "countryCodes": [

				"DE"

			],

			"websiteUrl": "https://www.example.com/ch/",

			"imageUrl": "https://kqdxc4m5.de/logos_v2/
                         120x60/0b95eee638b5bdf679ca8cf9c11beaa7.gif",


			"hostname": "example.com",

			"merchantId": null

			"updatedAt": "2022-05-17T10:17:39.000Z",

		},

        ...

	]

}

To view possible error responses, refer to the Error responses article.