curl --request GET \
--url https://{domain}/api/v2/network/offers/{offer_id}/custom-params \
--header 'X-API-Key: <api-key>'import requests
url = "https://{domain}/api/v2/network/offers/{offer_id}/custom-params"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://{domain}/api/v2/network/offers/{offer_id}/custom-params', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{domain}/api/v2/network/offers/{offer_id}/custom-params",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{domain}/api/v2/network/offers/{offer_id}/custom-params"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{domain}/api/v2/network/offers/{offer_id}/custom-params")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{domain}/api/v2/network/offers/{offer_id}/custom-params")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": "success",
"code": 200,
"name": "OK",
"message": "Custom Params List",
"info": {
"custom-params": [
{
"id": 134,
"status": 1,
"affiliates": [
{
"id": 5,
"title": "Sample Affiliate"
}
],
"start_date": "2026-09-01",
"end_date": "",
"conditions": [
{
"type": 4,
"permission": 1,
"conditions": [
{
"id": 2,
"title": "Etisalat AF",
"country": "AF"
}
]
}
],
"parameters": [
{
"type": 1,
"cap_type": null,
"goal_id": {
"id": 1728,
"title": "CPA"
},
"parameter": "32"
}
],
"created": 1788264850,
"updated": 1788264850
}
]
}
}{
"status": "error",
"code": 400,
"name": "Bad Request",
"message": "Request could not be parsed.",
"info": {
"errors": {}
}
}{
"status": "error",
"code": 401,
"name": "Unauthorized",
"message": "API key is invalid or missing."
}{
"status": "error",
"code": 403,
"name": "Forbidden",
"message": "This endpoint is not available for your role."
}{
"status": "error",
"code": 404,
"name": "Not Found",
"message": "Resource not found."
}{
"status": "error",
"code": 500,
"name": "Internal Server Error",
"message": "An unexpected error occurred.",
"info": {
"errors": {}
}
}List custom params
Returns the custom parameter rules of an offer — dated, per-affiliate, per-condition overrides of the offer’s revenue, payout, caps, throttle rates and redirects. See conditions (what the rule targets) and parameters (what it overrides) in the response schema. Parameter entries that affect revenue or payout may be omitted based on current user permissions.
curl --request GET \
--url https://{domain}/api/v2/network/offers/{offer_id}/custom-params \
--header 'X-API-Key: <api-key>'import requests
url = "https://{domain}/api/v2/network/offers/{offer_id}/custom-params"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://{domain}/api/v2/network/offers/{offer_id}/custom-params', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{domain}/api/v2/network/offers/{offer_id}/custom-params",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{domain}/api/v2/network/offers/{offer_id}/custom-params"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{domain}/api/v2/network/offers/{offer_id}/custom-params")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{domain}/api/v2/network/offers/{offer_id}/custom-params")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": "success",
"code": 200,
"name": "OK",
"message": "Custom Params List",
"info": {
"custom-params": [
{
"id": 134,
"status": 1,
"affiliates": [
{
"id": 5,
"title": "Sample Affiliate"
}
],
"start_date": "2026-09-01",
"end_date": "",
"conditions": [
{
"type": 4,
"permission": 1,
"conditions": [
{
"id": 2,
"title": "Etisalat AF",
"country": "AF"
}
]
}
],
"parameters": [
{
"type": 1,
"cap_type": null,
"goal_id": {
"id": 1728,
"title": "CPA"
},
"parameter": "32"
}
],
"created": 1788264850,
"updated": 1788264850
}
]
}
}{
"status": "error",
"code": 400,
"name": "Bad Request",
"message": "Request could not be parsed.",
"info": {
"errors": {}
}
}{
"status": "error",
"code": 401,
"name": "Unauthorized",
"message": "API key is invalid or missing."
}{
"status": "error",
"code": 403,
"name": "Forbidden",
"message": "This endpoint is not available for your role."
}{
"status": "error",
"code": 404,
"name": "Not Found",
"message": "Resource not found."
}{
"status": "error",
"code": 500,
"name": "Internal Server Error",
"message": "An unexpected error occurred.",
"info": {
"errors": {}
}
}Authorizations
Preferred authentication method. Pass the API key in the X-API-Key HTTP request header. The user account must have api_status enabled.
Path Parameters
Offer ID.
Query Parameters
Filter by status: active or inactive. Omit for both.
active, inactive Free-text search over the rule's conditions and parameters JSON, its affiliate ids, the affiliate company names and the titles of the traffic sources it targets.
Sort field. Only id is supported (the default).
id Sort direction: asc or desc. Default: desc.
asc, desc Page number.
Items per page. Default: 10.
Was this page helpful?