# Offers API

```
GET https://api.offer18.com/api/af/offers
```

:link: [<mark style="color:blue;">**Click to Test Offers API**</mark>](https://offer18.readme.io/reference/offers-api-1)

### **Common Parameters**

<table data-header-hidden><thead><tr><th width="150">Path</th><th width="150"> </th><th> </th></tr></thead><tbody><tr><td><strong>Parameter</strong></td><td><strong>Type</strong></td><td><strong>Description</strong></td></tr><tr><td>key</td><td>String</td><td>API Key</td></tr><tr><td>aid</td><td>Integer</td><td>Affiliate Id</td></tr><tr><td>mid</td><td>Integer</td><td>Your Advertiser MID</td></tr></tbody></table>

***

### Filters

<table data-header-hidden><thead><tr><th width="150">Query</th><th width="150"> </th><th width="376.2"> </th></tr></thead><tbody><tr><td><strong>Query</strong></td><td><strong>Type</strong></td><td><strong>Description</strong></td></tr><tr><td>offer_id</td><td>Integer</td><td>OfferID (&#x26;offer_id=000,001,002)</td></tr><tr><td>page</td><td>Integer</td><td>Page Number (&#x26;page=1)</td></tr><tr><td>category</td><td>String</td><td>Offer's category (&#x26;category=000,000,000)</td></tr><tr><td>model</td><td>String</td><td><p>Offer Model (&#x26;model=CPA,CPC) </p><p><span data-gb-custom-inline data-tag="emoji" data-code="1f517">🔗</span> <a href="/pages/ytQjT8cViRfxea7uvzlN#models"><mark style="color:blue;">View Models</mark></a></p></td></tr><tr><td>country</td><td>String</td><td><p>Country Based Offers (&#x26;country=US, IN, AU) </p><p><span data-gb-custom-inline data-tag="emoji" data-code="1f517">🔗</span> <a href="/pages/ytQjT8cViRfxea7uvzlN#countries"><mark style="color:blue;">View Countries</mark></a></p></td></tr><tr><td><strong>offer_status</strong></td><td>Integer</td><td>Allowed values:<br><strong>1:</strong> Active offers (&#x26;offer_status=1)</td></tr><tr><td><strong>authorized</strong></td><td>Integer</td><td>Allowed values:<br><strong>1:</strong> Assigned Offers (&#x26;authorized=1)</td></tr></tbody></table>

{% code overflow="wrap" %}

```
https://api.offer18.com/api/af/offers?key=000000000&aid=0000&mid=0000&offer_id=0000000&model=000
```

{% endcode %}

***

### Example API Request

![](/files/ejUpULSCS7s7yfCToPo9)

***

### **API Response**

```json
{
  "response": "200",
  "data": {
    "00011": {
      "offerid": "00011",
      "name": "XXXXX",
      "logo": "https://example.com/sample.jpeg/",
      "status": "active",
      "category": "download campaigns, gaming, subscription offers, Ecommerece Campaign",
      "currency": "USD",
      "price": 100,
      "model": "CPA",
      "date_start": "2019-05-09 02:19:00",
      "date_end": "2021-08-31 02:19:00",
      "preview_url": "https://www.example.com/?offerid=00011",
      "offer_terms": "These are the offer terms",
      "offer_kpi": "",
      "country_allow": "IN,US",
      "country_block": "GB",
      "city_allow": "",
      "city_block": "",
      "os_allow": "",
      "os_block": "",
      "device_allow": "",
      "device_block": "",
      "isp_allow": "",
      "isp_block": "",
      "browser_allow": "",
      "browser_block": "",
      "capping": [
        {
          "rule_type": "shared_capping",
          "event": "",
          "type": "gross_conversions",
          "period": "daily",
          "value": 100,
          "timezone": null,
          "rule_id": "00000"
        },
        {
          "rule_type": "affiliate_capping",
          "event": "",
          "type": "approved_conversions",
          "period": "daily",
          "value": 100,
          "timezone": null,
          "rule_id": "00000"
        }
      ],
      "events": [
        {
          "event_name": "registration",
          "event_token": "registration"
        }
      ],
      "payout": [
        {
          "payout": "515.0000",
          "currency": "USD",
          "model": "CPA",
          "condition": [
            [
              {
                "field": "event",
                "operator_type": "is_equal",
                "value": "reagistration"
              },
              {
                "field": "country",
                "operator_type": "is_equal",
                "value": "US"
              },
              {
                "field": "device_type",
                "operator_type": "is_equal",
                "value": "smartphone"
              },
              {
                "field": "browser",
                "operator_type": "is_equal",
                "value": "ch"
              },
              {
                "field": "os",
                "operator_type": "is_equal",
                "value": "android"
              }
            ]
          ],
          "rule_id": "00000"
        }
      ],
      "suppression_list": [
        {
          "name": "Sample Suppression list",
          "file_url": "https:\/\/storage.googleapis.com\/offer18-user-data\/suppression\/0000\/3dd0e00000f9202c8602b84feaf7_file.zip?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=service-account%40offer18.iam.gserviceaccount.com%2F20250324%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20250324T122057Z&X-Goog-Expires=172800&X-Goog-SignedHeaders=host&X-Goog-Signature=5ce353be3a209f62098d934b32b40d3af66b52a203ca821158c642a7c80c939af5bbad6435c2ce441b24e52df7f7bed4d4c54af8c4a8b54510c1dd7a55922ea49e52e1d1d4b6060000000653252a5d09c272f4748acf990c6eee95e166a87515fe984224fd587cf2c33d",
          "unsubscribe_url": "https:\/\/example.com",
          "subject_lines": "sample subject lines",
          "from_lines": "sample from lines"
        }
      ],
      "impression_url": "https://mynet.o18.click/i?o=00011&m=000&a=00000",
      "click_url": "https://mynet.o18.click/c?o=00011&m=000&a=00000",
      "authorized": "true",
      "creatives": [
        {
          "type": "image",
          "url": "https://example.com/creative_00001.png"
        },
        {
          "type": "image",
          "url": "https://example.com/creative_00002.png"
        },
        {
          "type": "html",
          "url": "https:example.com/creative00002.zip"
        }
      ],
      "targeting": [
        {
          "action_on_clicks": "allow",
          "condition": [
            [
              {
                "field": "country",
                "operator_type": "is_equal",
                "value": "IN,US"
              },
              {
                "field": "device_type",
                "operator_type": "not_equal",
                "value": "smartphone"
              }
            ]
          ],
          "rule_id": "101"
        },
        {
          "action_on_clicks": "reject",
          "condition": [
            [
              {
                "field": "os",
                "operator_type": "not_equal",
                "value": "android"
              }
            ]
          ],
          "rule_id": "102"
        },
        {
          "action_on_impressions": "allow",
          "condition": [
            [
              {
                "field": "country",
                "operator_type": "is_equal",
                "value": "IN,US"
              },
              {
                "field": "os",
                "operator_type": "is_equal",
                "value": "windows"
              }
            ]
          ],
          "rule_id": "103"
        }
      ]
    }
  }
}
```

{% hint style="info" %}

1. **Shared Capping -** A single capping rule shared by multiple Affiliates.
2. The Suppression File URL will be valid for only 2 hours. We recommend downloading and using the file promptly to ensure uninterrupted access and functionality.
   {% endhint %}

#### Apply Offer

<table data-header-hidden><thead><tr><th width="163.8046846634862">Query</th><th width="150"> </th><th width="407.6775081031496"> </th></tr></thead><tbody><tr><td><strong>Query</strong></td><td><strong>Type</strong></td><td><strong>Description</strong></td></tr><tr><td>offer_access</td><td>Integer</td><td>Allowed values<br><strong>1:</strong> Approve Public Offers (&#x26;offer_access=1)</td></tr></tbody></table>

{% code overflow="wrap" %}

```
https://api.offer18.com/api/af/offers?key=000000000&aid=0000&mid=0000&offer_access=1
```

{% endcode %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://knowledgebase.offer18.com/affiliate/affiliate-apis/offers-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.