> For the complete documentation index, see [llms.txt](https://offerslook-api.gitbook.io/api-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://offerslook-api.gitbook.io/api-documentation/affiliate_api/offers/get_offers_information.md).

# Get offer’s information

| HTTP method | Endpoint           |
| ----------- | ------------------ |
| **GET**     | **/aff/v1/offers** |

## Path parameters <a href="#path-parameters-0" id="path-parameters-0"></a>

| Parameter | Description      |
| --------- | ---------------- |
| all       | All offers.      |
| personal  | Personal offers. |

## Query string parameters <a href="#query-string-parameters" id="query-string-parameters"></a>

| Conditions | Parameters           | Type    | Description                                                                                                                               |
| ---------- | -------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| type       | type                 | type    | Possible Values: all · personal                                                                                                           |
| Offset     | offset               | offset  | Check page scale.                                                                                                                         |
| Limit      | limit                | limit   | The number of date displays in each page. **Maximum = 200**                                                                               |
| Sort       | sort                 | sort    | Ranking according to the specified field ascending "+", or descending "-".Only id sorting is supported.                                   |
| Filters    | filters              | filter  | Query requirements of Specify field.                                                                                                      |
|            |                      |         | EQUAL\_TO    NOT\_EQUAL\_TO    LESS\_THAN    LESS\_THAN\_OR\_EQUAL\_TO    GREATER\_THAN    GREATER\_THAN\_OR\_EQUAL\_TO                   |
| Fields     | fields               | field   | You can choose the field of the query (the result of the query is in line with the selected field).                                       |
|            | id                   | integer | A string that uniquely identifies this offer.                                                                                             |
|            | name                 | string  | The name of the this Offer                                                                                                                |
|            | end\_date            | integer | The expiration date of the Offer.                                                                                                         |
|            | status               | string  | The current status of the offer.                                                                                                          |
|            | pricing\_type        | string  | The current pricing\_type of the offer.   Possible Values:   CPA · CPI ·  CPL · CPM · CPC · CPS · CPA+CPS                                 |
|            | payout               | string  | The payout of the offer.                                                                                                                  |
|            | percent\_payout      | string  | Percent payout.                                                                                                                           |
|            | preview\_url         | string  | URL that often skips any geo-targeting or other re-targeting implemented by the Offer URL. Allows Affiliates to view sample landing page. |
|            | thumbnail            | string  | The offer’s thumbnail of the link address.                                                                                                |
|            | category             | string  | The category of the offer (***categroy means the tag information***).                                                                     |
|            | offer\_approval      | integer | Whether this Offer requires manual approval before an Affiliate can run it.  Possible Values:  1 Require Approval   2 Public   3 Private  |
|            | tracking\_link       | string  | Tracking link.   ***NOTE: tracking link can be acquired only in the case of Personal Offer.***                                            |
|            | currency             | string  | The currency of the Offer.                                                                                                                |
|            | conversion\_protocol | integer | The Conversion tracking method to use for the Offer.   Possible Values:  1:Image Pixel;   2:Postback URL;   3:iFrame Pixel                |
|            | app\_id              | string  | the App ID on app store or google play                                                                                                    |
|            | event                | object  | Offer event.                                                                                                                              |
| Contains   | contains             | string  | List of related objects to return with each result.                                                                                       |
|            | description          | string  | A description for the Offer. Default does not return,   if needed, by the following ways. For example,contains=description                |
|            | EPC1                 | string  | Offers can be pulled according to EPC, for example,contains=EPC1,EPC1 means offers is pulled according to EPC of today                    |
|            | EPC2                 | string  | EPC2 means offers is pulled according to EPC of yesterday                                                                                 |
|            | EPC3                 | string  | EPC3 means offers is pulled according to EPC of last three days                                                                           |
|            | EPC4                 | string  | EPC4 means offers is pulled according to EPC of last 7 days                                                                               |
|            | CR1                  | string  | Offers can be pulled according to CR, for example,contains=CR1,CR1 means offers is pulled according to CR of today                        |
|            | CR2                  | string  | CR2 means offers is pulled according to CR of yesterday                                                                                   |
|            | CR3                  | string  | CR3 means offers is pulled according to CR of last three days                                                                             |
|            | CR4                  | string  | CR4 means offers is pulled according to CR of last 7 days                                                                                 |

## Response body parameters <a href="#response-body-parameters" id="response-body-parameters"></a>

| Field                | Type    | Description                                                                                                                               |
| -------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| id                   | integer | A string that uniquely identifies this offer.                                                                                             |
| name                 | string  | The name of the this Offer                                                                                                                |
| end\_date            | integer | The expiration date of the Offer.                                                                                                         |
| status               | string  | The current status of the offer.                                                                                                          |
| pricing\_type        | string  | The current pricing\_type of the offer.   Possible Values:   CPA·CPL·CPM·CPI·CPC·CPS·CPA+CPS                                              |
| payout               | string  | The payout of the offer.                                                                                                                  |
| preview\_url         | string  | URL that often skips any geo-targeting or other re-targeting implemented by the Offer URL. Allows Affiliates to view sample landing page. |
| description          | string  | A description for the Offer.                                                                                                              |
| thumbnail            | string  | The offer’s thumbnail of the link address.                                                                                                |
| category             | string  | The category of the offer.                                                                                                                |
| offer\_approval      | integer | Whether this Offer requires manual approval before an Affiliate can run it.                                                               |
| tracking\_link       | string  | Tracking link.   ***NOTE: tracking link can be acquired only in the case of Personal Offer.***                                            |
| currency             | string  | The currency of the Offer.                                                                                                                |
| conversion\_protocol | integer | The Conversion tracking method to use for the Offer.   Possible Values:  1:Image Pixel;   2:Postback URL;   3:iFrame Pixel                |
| carrier\_mode        | integer | carrier\_mode indicates the Mobile Carrier type.1 indicates include. 2 indicates exclude.                                                 |
| event                | object  | Offer event.                                                                                                                              |
| impression\_pixel    | string  | impression pixel.   ***NOTE: impression\_pixel link can be acquired only in the case of Personal Offer.***                                |
| carrier              | array   | Mobile Carrier                                                                                                                            |
| app\_id              | string  | the App ID on app store or google play                                                                                                    |
| browser              | array   | Browser                                                                                                                                   |
| totalPages           | integer | The list of data pages (associated with your limit).                                                                                      |
| totalRows            | integer | Total number of available data.                                                                                                           |
| offset               | integer | The number of records from a collection to skip. Iterating over large collections with this parameter can be slow.                        |
| limit                | integer | The number of data displayed on one page.                                                                                                 |

## Example request <a href="#example-request-0" id="example-request-0"></a>

**Request GET** <https://{networkname}.api.offerslook.com/aff/v1/offers?type=all&sort=+id&limit=10&offset=2&filters[id][GREATER_THAN]=10>

**Request GET** <http://{networkname}.api.offerslook.com/aff/v1/offers?type=all&sort=+id&limit=10&offset=2&filters[id][GREATER_THAN]=10>

## Example response <a href="#example-response-0" id="example-response-0"></a>

```
    {
      "code": 0,
      "message": "Success",
      "data": {
        "rowset": [
          {
            "id": 15,
            "category": "test",
            "offer_approval": 2,
            "tracking_link": "http://click.dev.offerslook.com:9080/index.php?offer_id=15&aff_id=161",
            "end_date": 1493999999,
            "pricing_type": "CPA",
            "payout": "1",
            "percent_payout": "-1",
            "preview_url": "https://www.offerslook.com/",
            "currency": "USD",
            "conversion_protocol": 2,
            "app_id": "871125783",
             "impression_pixel": "<img src='http://qoqololo.iuniontrack.com:9080/impr.php?offer_id=15&aff_id=161'  border='0'  width='1'  height='1' />",
             "carrier": [],
              "browser": [
                    "Chrome",
                    "360 Browser",
                    "Amaya"
                ],
            "event": [
              {
                "event_id": 1,
                "event_name": "Initial Event",
                "event_payout_type": "CPA",
                "event_payout": "1.000",
                "event_percent_payout": "-1",
                "conversion_protocol": 2
              },
              {
                "event_id": 2,
                "event_name": "TEST",
                "event_payout_type": "CPA+CPS",
                "event_payout": "2.000",
                "event_percent_payout": "10",
                "conversion_protocol": 3
              }
            ]
          },
          {
            "id": 17,
            "category": "test",
            "offer_approval": 1,
            "tracking_link": "",
            "end_date": 1493999999,
            "pricing_type": "CPS",
            "payout": "-1",
            "percent_payout": "2",
            "preview_url": "https://www.offerslook.com/",
            "currency": "USD",
            "conversion_protocol": 2,
            "event": [
              {
                "event_id": 1,
                "event_name": "Initial Event",
                "event_payout_type": "CPS",
                "event_payout": "-1",
                "event_percent_payout": "2",
                "conversion_protocol": 2
              }
            ]
          },
          {
            "id": 18,
            "category": "test",
            "offer_approval": 1,
            "tracking_link": "",
            "end_date": 1493999999,
            "pricing_type": "CPC",
            "payout": "2",
            "percent_payout": "-1",
            "preview_url": "https://offerslook.gitbooks.io/api-documentation/content/index.html",
            "currency": "USD",
            "conversion_protocol": 1,
            "event": [
              {
                "event_id": 1,
                "event_name": "Initial Event",
                "event_payout_type": "CPC",
                "event_payout": "2",
                "event_percent_payout": "-1",
                "conversion_protocol": 2
              }
            ]
          }
        ],
        "totalPages": 2,
        "totalRows": 13,
        "offset": 2,
        "limit": 10
      }
    }
```
