> For the complete documentation index, see [llms.txt](https://docs.shoffi.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.shoffi.app/the-shoffi-api/get-affiliate-info.md).

# Get Affiliate Info

## Get all information about a specific affiliate

<mark style="color:blue;">`GET`</mark> `https://platform.shoffi.app/API/affiliate/getInfo`

#### Request Body

| Name                                     | Type    | Description                 |
| ---------------------------------------- | ------- | --------------------------- |
| apiKey<mark style="color:red;">\*</mark> | String  | Your Shoffi app API Key     |
| appId<mark style="color:red;">\*</mark>  | Integer | Your app ID                 |
| email<mark style="color:red;">\*</mark>  | String  | The affiliate email address |

{% tabs %}
{% tab title="200: OK " %}

```json
{
    "affiliateDetails": {
        "email": "tobias@lutke.com",
        "firstName": "Tobias",
        "lastName": "Lütke",
        "nickName": "tobi"
    },
    "affiliateTerms": {
        "revenueShare": 30,
        "cpi": 10,
        "limitPeriod": 24,
        "minWithdrawal": 50
    },
    "affiliatePerformance": {
        "appProfit": 1000,
        "affiliateProfit": 300,
        "paidToAffiliate": 100,
        "linkViews": 72
    },
    "affiliateLink": "https://platform.shoffi.app/r/rl_xxxxxxxx",
    "referralCount": 10
}
```

{% endtab %}

{% tab title="400: Bad Request " %}

```javascript
{
    "status": 400,
    "message": "Error details"
}
```

{% endtab %}
{% endtabs %}

```
curl -X POST \
  https://platform.shoffi.app/API/affiliate/getInfo \
  -H 'Content-Type: application/json' \
  -d '{
    "apiKey": "YourKey",
    "appId": 00000000,
    "email": "tobias@lutke.com"
  }'

```

## Response example

```json
200 OK
Content-Type: application/json
```

```json
{
    "affiliateDetails": {
        "email": "tobias@lutke.com",
        "firstName": "Tobias",
        "lastName": "Lütke",
        "nickName": "tobi"
    },
    "affiliateTerms": {
        "revenueShare": 30,
        "cpi": 10,
        "limitPeriod": 24,
        "minWithdrawal": 50,
        "recurringChargeOnly": true
    },
    "affiliatePerformance": {
        "appProfit": 1000,
        "affiliateProfit": 300,
        "paidToAffiliate": 100,
        "linkViews": 72
    },
    "affiliateLink": "https://platform.shoffi.app/r/rl_xxxxxxxx",
    "referralCount": 10
}
```