AI API Services

https://www.promotekit.com/docs
Admin
This project provides backend API services and worker functionalities, integrating with large...
Tokens:33,266
Snippets:143
Trust Score:8.3
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install Svix Library (JavaScript)

Source: https://www.promotekit.com/docs/webhooks

Install the Svix library using npm for JavaScript projects.

```bash
npm install svix
```

--------------------------------

### Get Campaign using Python

Source: https://www.promotekit.com/docs/api-reference/campaigns/get-campaign

A Python example demonstrating how to fetch campaign data using the `requests` library. It includes setting the Authorization header for the API request.

```python
import requests

url = "https://www.promotekit.com/api/v1/campaigns/497f6eca-6276-4993-bfeb-53cbbbba6f08"
headers = {
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)
print(response.json())
```

--------------------------------

### Get Campaign using Go

Source: https://www.promotekit.com/docs/api-reference/campaigns/get-campaign

This Go code snippet shows how to make a GET request to retrieve a campaign. It includes setting up the HTTP client and request headers.

```go
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {
  client := &http.Client{}
  req, err := http.NewRequest("GET", "https://www.promotekit.com/api/v1/campaigns/497f6eca-6276-4993-bfeb-53cbbbba6f08", nil)
  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Authorization", "Bearer <token>")

  resp, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer resp.Body.Close()

  body, err := ioutil.ReadAll(resp.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}
```

--------------------------------

### Get a Single Payout (JavaScript)

Source: https://www.promotekit.com/docs/api-reference/payouts/get-payout

Example of how to fetch a payout using JavaScript's fetch API. This demonstrates making a GET request with the necessary Authorization header.

```javascript
fetch("https://www.promotekit.com/api/v1/payouts/497f6eca-6276-4993-bfeb-53cbbbba6f08", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
```

--------------------------------

### Successful Response Example

Source: https://www.promotekit.com/docs/api-reference/referrals/list-referrals

An example of a successful response when listing referrals, including referral data and pagination details.

```json
{
  "success": true,
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "email": "user@example.com",
      "subscription_status": "active",
      "signup_date": "2019-08-24T14:15:22Z",
      "stripe_customer_id": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "affiliate": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "email": "user@example.com",
        "first_name": "string",
        "last_name": "string",
        "payout_email": "user@example.com",
        "links": [
          {
            "url": "string",
            "code": "string"
          }
        ],
        "promo_codes": [
          {
            "code": "string",
            "external_id": "string"
          }
        ],
        "clicks": 0,
        "approved": true,
        "banned": true,
        "details": "string",
        "new_paid_referral_notifications": true,
        "created_at": "2019-08-24T14:15:22Z",
        "campaign": {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string",
          "created_at": "2019-08-24T14:15:22Z",
          "website_url": "string",
          "commission_type": "percentage",
          "commission_amount": 0,
          "is_default": true,
          "limit_type": "string",
          "limit_amount": 0,
          "code_mode": "link",
          "reference_coupon": "string",
          "custom_commission_type": "string",
          "welcome_message": "string",
          "approval_needed": true,
          "collect_details": true,
          "details_text": "string",
          "hide_emails": true,
          "dashboard_text": "string",
          "cookie_duration": 0,
          "first_payment_commission": {
            "enabled": true,
            "type": "string",
            "amount": 0
          }
        }
      }
    }
  ],
  "pagination": {
    "page": 0,
    "limit": 0,
    "total_count": 0,
    "total_pages": 0,
    "has_more": true
  }
}
```

--------------------------------

### Successful Response Example

Source: https://www.promotekit.com/docs/api-reference/payouts/list-payouts

This is an example of a successful response when listing payouts. It includes payout details, affiliate information, and pagination metadata.

```JSON
{
  "success": true,
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "affiliate_name": "string",
      "payout_email": "user@example.com",
      "amount": 0,
      "currency": "string",
      "period": "string",
      "payment_count": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "affiliate": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "email": "user@example.com",
        "first_name": "string",
        "last_name": "string",
        "payout_email": "user@example.com",
        "links": [
          {
            "url": "string",
            "code": "string"
          }
        ],
        "promo_codes": [
          {
            "code": "string",
            "external_id": "string"
          }
        ],
        "clicks": 0,
        "approved": true,
        "banned": true,
        "details": "string",
        "new_paid_referral_notifications": true,
        "created_at": "2019-08-24T14:15:22Z",
        "campaign": {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string",
          "created_at": "2019-08-24T14:15:22Z",
          "website_url": "string",
          "commission_type": "percentage",
          "commission_amount": 0,
          "is_default": true,
          "limit_type": "string",
          "limit_amount": 0,
          "code_mode": "link",
          "reference_coupon": "string",
          "custom_commission_type": "string",
          "welcome_message": "string",
          "approval_needed": true,
          "collect_details": true,
          "details_text": "string",
          "hide_emails": true,
          "dashboard_text": "string",
          "cookie_duration": 0,
          "first_payment_commission": {
            "enabled": true,
            "type": "string",
            "amount": 0
          }
        }
      }
    }
  ],
  "pagination": {
    "page": 0,
    "limit": 0,
    "total_count": 0,
    "total_pages": 0,
    "has_more": true
  }
}
```

--------------------------------

### Get Campaign using JavaScript

Source: https://www.promotekit.com/docs/api-reference/campaigns/get-campaign

Example of fetching a campaign using JavaScript's fetch API. This code snippet demonstrates how to make a GET request to the campaigns endpoint, including the necessary Authorization header.

```javascript
fetch("https://www.promotekit.com/api/v1/campaigns/497f6eca-6276-4993-bfeb-53cbbbba6f08", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
})
  .then(response => response.json())
  .then(data => console.log(data));
```

--------------------------------

### Get a Single Payout (Python)

Source: https://www.promotekit.com/docs/api-reference/payouts/get-payout

A Python example using the `requests` library to fetch payout details. It demonstrates setting the Authorization header for the API request.

```python
import requests

url = "https://www.promotekit.com/api/v1/payouts/497f6eca-6276-4993-bfeb-53cbbbba6f08"
headers = {
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

if response.status_code == 200:
    print(response.json())
else:
    print(f"Error: {response.status_code}")
    print(response.text)
```

--------------------------------

### Create Affiliate Response

Source: https://www.promotekit.com/docs/api-reference/affiliates/create-affiliate

Example JSON response when an affiliate is successfully created.

```json
{
  "success": true,
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "email": "user@example.com",
    "first_name": "string",
    "last_name": "string",
    "payout_email": "user@example.com",
    "links": [
      {
        "url": "string",
        "code": "string"
      }
    ],
    "promo_codes": [
      {
        "code": "string",
        "external_id": "string"
      }
    ],
    "clicks": 0,
    "approved": true,
    "banned": true,
    "details": "string",
    "new_paid_referral_notifications": true,
    "created_at": "2019-08-24T14:15:22Z",
    "campaign": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "website_url": "string",
      "commission_type": "percentage",
      "commission_amount": 0,
      "is_default": true,
      "limit_type": "string",
      "limit_amount": 0,
      "code_mode": "link",
      "reference_coupon": "string",
      "custom_commission_type": "string",
      "welcome_message": "string",
      "approval_needed": true,
      "collect_details": true,
      "details_text": "string",
      "hide_emails": true,
      "dashboard_text": "string",
      "cookie_duration": 0,
      "first_payment_commission": {
        "enabled": true,
        "type": "string",
        "amount": 0
      }
    }
  }
}
```

--------------------------------

### Create Referral (Go)

Source: https://www.promotekit.com/docs/api-reference/referrals/create-referral

Example of creating a referral using Go. This snippet shows how to set up the HTTP request, including headers and the JSON body.

```go
package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"net/http"
)

func main() {
	token := "<token>"
	affiliateID := "3b7d610b-bb33-4bfb-8025-7abb425f8603"
	email := "user@example.com"
	stripeCustomerID := "string"
	subscriptionStatus := "active"

	requestBody, err := json.Marshal(map[string]string{
		"affiliate_id": affiliateID,
		"email": email,
		"stripe_customer_id": stripeCustomerID,
		"subscription_status": subscriptionStatus
	})
	if err != nil {
		fmt.Println("Error marshalling request body:", err)
		return
	}

	req, err := http.NewRequest("POST", "https://www.promotekit.com/api/v1/referrals", bytes.NewBuffer(requestBody))
	if err != nil {
		fmt.Println("Error creating request:", err)
		return
	}

	req.Header.Set("Authorization", "Bearer "+token)
	req.Header.Set("Content-Type", "application/json")

	client := &http.Client{}
	res, err := client.Do(req)
	if err != nil {
		fmt.Println("Error sending request:", err)
		return
	}
	defer res.Body.Close()

	var result map[string]interface{}
	if err := json.NewDecoder(res.Body).Decode(&result); err != nil {
		fmt.Println("Error decoding response:", err)
		return
	}

	fmt.Println(result)
}
```

--------------------------------

### List Commissions (cURL)

Source: https://www.promotekit.com/docs/api-reference/commissions/list-commissions

Example of how to list commissions using cURL, demonstrating various query parameters for filtering and pagination. Ensure you replace `<token>` with your actual Authorization token.

```curl
curl -X GET "https://www.promotekit.com/api/v1/commissions?affiliate_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&payout_status=not_paid&payout_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&limit=10&page=1" \
  -H "Authorization: Bearer <token>"
```

--------------------------------

### Create Referral (Python)

Source: https://www.promotekit.com/docs/api-reference/referrals/create-referral

Example of creating a referral using Python's requests library. This snippet demonstrates how to send a POST request with JSON data and authentication headers.

```python
import requests
import json

token = "<token>"
affiliate_id = "3b7d610b-bb33-4bfb-8025-7abb425f8603"
email = "user@example.com"
stripe_customer_id = "string"
subscription_status = "active"

url = "https://www.promotekit.com/api/v1/referrals"
headers = {
    "Authorization": f"Bearer {token}",
    "Content-Type": "application/json"
}
data = {
    "affiliate_id": affiliate_id,
    "email": email,
    "stripe_customer_id": stripe_customer_id,
    "subscription_status": subscription_status
}

response = requests.post(url, headers=headers, data=json.dumps(data))

print(response.json())
```

--------------------------------

### Create Referral (JavaScript)

Source: https://www.promotekit.com/docs/api-reference/referrals/create-referral

Example of creating a referral using JavaScript's fetch API. This snippet demonstrates how to construct the request payload and headers.

```javascript
const token = "<token>";
const affiliateId = "3b7d610b-bb33-4bfb-8025-7abb425f8603";
const email = "user@example.com";
const stripeCustomerId = "string";
const subscriptionStatus = "active";

fetch("https://www.promotekit.com/api/v1/referrals", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${token}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    affiliate_id: affiliateId,
    email: email,
    stripe_customer_id: stripeCustomerId,
    subscription_status: subscriptionStatus
  })
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error("Error:", error));
```

--------------------------------

### Successful Response for Listing Affiliates

Source: https://www.promotekit.com/docs/api-reference/affiliates/list-affiliates

This is an example of a successful response when listing affiliates. It includes affiliate data and pagination details.

```json
{
  "success": true,
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "email": "user@example.com",
      "first_name": "string",
      "last_name": "string",
      "payout_email": "user@example.com",
      "links": [
        {
          "url": "string",
          "code": "string"
        }
      ],
      "promo_codes": [
        {
          "code": "string",
          "external_id": "string"
        }
      ],
      "clicks": 0,
      "approved": true,
      "banned": true,
      "details": "string",
      "new_paid_referral_notifications": true,
      "created_at": "2019-08-24T14:15:22Z",
      "campaign": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string",
        "created_at": "2019-08-24T14:15:22Z",
        "website_url": "string",
        "commission_type": "percentage",
        "commission_amount": 0,
        "is_default": true,
        "limit_type": "string",
        "limit_amount": 0,
        "code_mode": "link",
        "reference_coupon": "string",
        "custom_commission_type": "string",
        "welcome_message": "string",
        "approval_needed": true,
        "collect_details": true,
        "details_text": "string",
        "hide_emails": true,
        "dashboard_text": "string",
        "cookie_duration": 0,
        "first_payment_commission": {
          "enabled": true,
          "type": "string",
          "amount": 0
        }
      }
    }
  ],
  "pagination": {
    "page": 0,
    "limit": 0,
    "total_count": 0,
    "total_pages": 0,
    "has_more": true
  }
}
```

--------------------------------

### Create Referral (cURL)

Source: https://www.promotekit.com/docs/api-reference/referrals/create-referral

Example of creating a referral using cURL. Ensure you replace `<token>` with your actual API token and adjust the request body as needed.

```bash
curl -X POST "https://www.promotekit.com/api/v1/referrals" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "affiliate_id": "3b7d610b-bb33-4bfb-8025-7abb425f8603",
    "email": "user@example.com",
    "stripe_customer_id": "string",
    "subscription_status": "active"
  }'
```

--------------------------------

### Campaign Creation Response

Source: https://www.promotekit.com/docs/api-reference/campaigns/create-campaign

This is an example of a successful response when a campaign is created. It includes the ID and details of the newly created campaign.

```json
{
  "success": true,
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "website_url": "string",
    "commission_type": "percentage",
    "commission_amount": 0,
    "is_default": true,
    "limit_type": "string",
    "limit_amount": 0,
    "code_mode": "link",
    "reference_coupon": "string",
    "custom_commission_type": "string",
    "welcome_message": "string",
    "approval_needed": true,
    "collect_details": true,
    "details_text": "string",
    "hide_emails": true,
    "dashboard_text": "string",
    "cookie_duration": 0,
    "first_payment_commission": {
      "enabled": true,
      "type": "string",
      "amount": 0
    }
  }
}
```

--------------------------------

### PromoteKit API Paginated List Response

Source: https://www.promotekit.com/docs/api-reference

Example of a paginated response for list endpoints. Includes data, pagination details, and a 'has_more' flag.

```json
{
  "success": true,
  "data": [...],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total_count": 45,
    "total_pages": 5,
    "has_more": true
  }
}
```

--------------------------------

### Successful Response

Source: https://www.promotekit.com/docs/api-reference/campaigns/list-campaigns

This is an example of a successful response when listing campaigns. It includes a 'data' array containing campaign objects and 'pagination' details.

```json
{
  "success": true,
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "website_url": "string",
      "commission_type": "percentage",
      "commission_amount": 0,
      "is_default": true,
      "limit_type": "string",
      "limit_amount": 0,
      "code_mode": "link",
      "reference_coupon": "string",
      "custom_commission_type": "string",
      "welcome_message": "string",
      "approval_needed": true,
      "collect_details": true,
      "details_text": "string",
      "hide_emails": true,
      "dashboard_text": "string",
      "cookie_duration": 0,
      "first_payment_commission": {
        "enabled": true,
        "type": "string",
        "amount": 0
      }
    }
  ],
  "pagination": {
    "page": 0,
    "limit": 0,
    "total_count": 0,
    "total_pages": 0,
    "has_more": true
  }
}
```

--------------------------------

### Update Affiliate (JavaScript)

Source: https://www.promotekit.com/docs/api-reference/affiliates/update-affiliate

Example of updating an affiliate using JavaScript with the Fetch API. This demonstrates how to construct the PUT request, including headers and the JSON payload.

```javascript
const affiliateId = "497f6eca-6276-4993-bfeb-53cbbbba6f08";
const token = "<token>";

fetch(`https://www.promotekit.com/api/v1/affiliates/${affiliateId}`, {
  method: "PUT",
  headers: {
    "Authorization": `Bearer ${token}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "email": "user@example.com",
    "first_name": "string",
    "last_name": "string",
    "payout_email": "user@example.com",
    "ref_code": "string",
    "promo_code": "string",
    "campaign_id": "78614b6c-fe7c-41e2-8e25-c9b3a3c91904",
    "approved": true,
    "banned": true,
    "details": "string",
    "new_paid_referral_notifications": true
  })
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
```

--------------------------------

### Successful Response Example

Source: https://www.promotekit.com/docs/api-reference/commissions/list-commissions

A successful response when listing commissions, showing the structure of the returned data, including commission details, affiliate information, referral data, payout details, and pagination metadata.

```json
{
  "success": true,
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "revenue_amount": 0,
      "currency": "string",
      "commission_amount": 0,
      "payout_status": "not_paid",
      "referral_date": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z",
      "stripe_payment_id": "string",
      "affiliate": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "email": "user@example.com",
        "first_name": "string",
        "last_name": "string",
        "payout_email": "user@example.com",
        "links": [
          {
            "url": "string",
            "code": "string"
          }
        ],
        "promo_codes": [
          {
            "code": "string",
            "external_id": "string"
          }
        ],
        "clicks": 0,
        "approved": true,
        "banned": true,
        "details": "string",
        "new_paid_referral_notifications": true,
        "created_at": "2019-08-24T14:15:22Z",
        "campaign": {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string",
          "created_at": "2019-08-24T14:15:22Z",
          "website_url": "string",
          "commission_type": "percentage",
          "commission_amount": 0,
          "is_default": true,
          "limit_type": "string",
          "limit_amount": 0,
          "code_mode": "link",
          "reference_coupon": "string",
          "custom_commission_type": "string",
          "welcome_message": "string",
          "approval_needed": true,
          "collect_details": true,
          "details_text": "string",
          "hide_emails": true,
          "dashboard_text": "string",
          "cookie_duration": 0,
          "first_payment_commission": {
            "enabled": true,
            "type": "string",
            "amount": 0
          }
        }
      },
      "referral": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "email": "user@example.com",
        "subscription_status": "active",
        "signup_date": "2019-08-24T14:15:22Z",
        "stripe_customer_id": "string",
        "created_at": "2019-08-24T14:15:22Z"
      },
      "payout": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "affiliate_name": "string",
        "payout_email": "user@example.com",
        "amount": 0,
        "currency": "string",
        "period": "string",
        "payment_count": 0,
        "created_at": "2019-08-24T14:15:22Z"
      }
    }
  ],
  "pagination": {
    "page": 0,
    "limit": 0,
    "total_count": 0,
    "total_pages": 0,
    "has_more": true
  }
}
```

--------------------------------

### Retrieve a Single Affiliate (Go)

Source: https://www.promotekit.com/docs/api-reference/affiliates/get-affiliate

This Go program shows how to retrieve affiliate information using an HTTP GET request. It sets the Authorization header with your Bearer token.

```go
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {
  url := "https://www.promotekit.com/api/v1/affiliates/497f6eca-6276-4993-bfeb-53cbbbba6f08"
  req, _ := http.NewRequest("GET", url, nil)
  req.Header.Set("Authorization", "Bearer <token>")

  client := &http.Client{}
  resp, err := client.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()

  body, _ := ioutil.ReadAll(resp.Body)
  fmt.Println(string(body))
}
```

--------------------------------

### Successful Commission Response

Source: https://www.promotekit.com/docs/api-reference/commissions/get-commission

This is an example of a successful response (200 OK) when retrieving commission details. It includes comprehensive information about the commission, affiliate, referral, and payout.

```json
{
  "success": true,
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "revenue_amount": 0,
    "currency": "string",
    "commission_amount": 0,
    "payout_status": "not_paid",
    "referral_date": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "stripe_payment_id": "string",
    "affiliate": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "email": "user@example.com",
      "first_name": "string",
      "last_name": "string",
      "payout_email": "user@example.com",
      "links": [
        {
          "url": "string",
          "code": "string"
        }
      ],
      "promo_codes": [
        {
          "code": "string",
          "external_id": "string"
        }
      ],
      "clicks": 0,
      "approved": true,
      "banned": true,
      "details": "string",
      "new_paid_referral_notifications": true,
      "created_at": "2019-08-24T14:15:22Z",
      "campaign": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string",
        "created_at": "2019-08-24T14:15:22Z",
        "website_url": "string",
        "commission_type": "percentage",
        "commission_amount": 0,
        "is_default": true,
        "limit_type": "string",
        "limit_amount": 0,
        "code_mode": "link",
        "reference_coupon": "string",
        "custom_commission_type": "string",
        "welcome_message": "string",
        "approval_needed": true,
        "collect_details": true,
        "details_text": "string",
        "hide_emails": true,
        "dashboard_text": "string",
        "cookie_duration": 0,
        "first_payment_commission": {
          "enabled": true,
          "type": "string",
          "amount": 0
        }
      }
    },
    "referral": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "email": "user@example.com",
      "subscription_status": "active",
      "signup_date": "2019-08-24T14:15:22Z",
      "stripe_customer_id": "string",
      "created_at": "2019-08-24T14:15:22Z"
    },
    "payout": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "affiliate_name": "string",
      "payout_email": "user@example.com",
      "amount": 0,
      "currency": "string",
      "period": "string",
      "payment_count": 0,
      "created_at": "2019-08-24T14:15:22Z"
    }
  }
}
```

--------------------------------

### Outseta Signup Tracking Script

Source: https://www.promotekit.com/docs/integrations/outseta

Add this script to your member signup page to listen for Outseta signup events and pass customer data to PromoteKit for referral tracking.

```javascript
<script>
Outseta.on(
  'signup',
  (account) => {
    window.promotekit.refer(
      account.PersonAccount[0].Person.Email,
      account.PaymentInformation.CustomerToken
    )
  }
);
</script>
```

--------------------------------

### Get a Single Payout (Go)

Source: https://www.promotekit.com/docs/api-reference/payouts/get-payout

This Go code snippet shows how to retrieve payout information using an HTTP GET request. It includes setting the Authorization header.

```go
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {
	client := &http.Client{}
	req, err := http.NewRequest("GET", "https://www.promotekit.com/api/v1/payouts/497f6eca-6276-4993-bfeb-53cbbbba6f08", nil)
	if err != nil {
		fmt.Println(err)
		return
	}

	req.Header.Add("Authorization", "Bearer <token>")

	resp, err := client.Do(req)
	if err != nil {
		fmt.Println(err)
		return
	}

	defer resp.Body.Close()

	body, err := ioutil.ReadAll(resp.Body)
	if err != nil {
		fmt.Println(err)
		return
	}

	fmt.Println(string(body))
}
```

--------------------------------

### Get a Single Payout (cURL)

Source: https://www.promotekit.com/docs/api-reference/payouts/get-payout

Use this cURL command to make a GET request to retrieve a specific payout by its ID. Ensure you replace `<token>` with your actual Authorization token.

```bash
curl -X GET "https://www.promotekit.com/api/v1/payouts/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "Authorization: Bearer <token>"
```

--------------------------------

### List Referrals with Query Parameters

Source: https://www.promotekit.com/docs/api-reference/referrals/list-referrals

Demonstrates how to list referrals using cURL, specifying various query parameters for filtering and pagination. Ensure you replace `<token>` with your actual Authorization token.

```curl
curl -X GET "https://www.promotekit.com/api/v1/referrals?affiliate_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&email=user%40example.com&stripe_customer_id=string&subscription_status=string&limit=10&page=1" \
  -H "Authorization: Bearer <token>"
```

--------------------------------

### Get Payout

Source: https://www.promotekit.com/docs/api-reference/payouts/get-payout

Retrieves a single payout by its UUID. Requires an Authorization header for authentication.

```APIDOC
## GET /payouts/{id}

### Description
Retrieves a single payout by its UUID.

### Method
GET

### Endpoint
/payouts/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Resource UUID. Format: "uuid"

#### Header Parameters
- **Authorization** (string) - Required - Bearer <token>

### Request Example
```
curl -X GET "https://www.promotekit.com/api/v1/payouts/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "Authorization: Bearer <token>"
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (object) - Contains the payout details.
  - **id** (string) - The payout UUID.
  - **affiliate_name** (string) - The name of the affiliate.
  - **payout_email** (string) - The email address for the payout.
  - **amount** (number) - The payout amount.
  - **currency** (string) - The currency of the payout.
  - **period** (string) - The payout period.
  - **payment_count** (number) - The number of payments included in this payout.
  - **created_at** (string) - The timestamp when the payout was created.
  - **affiliate** (object) - Details about the affiliate.
    - **id** (string) - The affiliate's UUID.
    - **email** (string) - The affiliate's email address.
    - **first_name** (string) - The affiliate's first name.
    - **last_name** (string) - The affiliate's last name.
    - **payout_email** (string) - The affiliate's payout email address.
    - **links** (array) - A list of affiliate links.
      - **url** (string) - The URL of the link.
      - **code** (string) - The promo code associated with the link.
    - **promo_codes** (array) - A list of affiliate promo codes.
      - **code** (string) - The promo code.
      - **external_id** (string) - The external ID of the promo code.
    - **clicks** (number) - The number of clicks generated by the affiliate.
    - **approved** (boolean) - Indicates if the affiliate is approved.
    - **banned** (boolean) - Indicates if the affiliate is banned.
    - **details** (string) - Additional details about the affiliate.
    - **new_paid_referral_notifications** (boolean) - Whether to send notifications for new paid referrals.
    - **created_at** (string) - The timestamp when the affiliate was created.
    - **campaign** (object) - Details about the affiliate's campaign.
      - **id** (string) - The campaign UUID.
      - **name** (string) - The name of the campaign.
      - **created_at** (string) - The timestamp when the campaign was created.
      - **website_url** (string) - The website URL for the campaign.
      - **commission_type** (string) - The type of commission (e.g., "percentage").
      - **commission_amount** (number) - The commission amount.
      - **is_default** (boolean) - Indicates if this is the default campaign.
      - **limit_type** (string) - The type of limit for the campaign.
      - **limit_amount** (number) - The amount of the limit.
      - **code_mode** (string) - The mode for generating promo codes (e.g., "link").
      - **reference_coupon** (string) - A reference coupon code for the campaign.
      - **custom_commission_type** (string) - A custom commission type.
      - **welcome_message** (string) - The welcome message for new affiliates.
      - **approval_needed** (boolean) - Whether affiliate approval is needed.
      - **collect_details** (boolean) - Whether to collect additional details from affiliates.
      - **details_text** (string) - Text explaining the details required from affiliates.
      - **hide_emails** (boolean) - Whether to hide affiliate emails.
      - **dashboard_text** (string) - Text displayed on the affiliate dashboard.
      - **cookie_duration** (number) - The duration of the tracking cookie in days.
      - **first_payment_commission** (object) - Settings for the first payment commission.
        - **enabled** (boolean) - Whether the first payment commission is enabled.
        - **type** (string) - The type of first payment commission.
        - **amount** (number) - The amount of the first payment commission.

#### Response Example
```json
{
  "success": true,
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "affiliate_name": "string",
    "payout_email": "user@example.com",
    "amount": 0,
    "currency": "string",
    "period": "string",
    "payment_count": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "affiliate": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "email": "user@example.com",
      "first_name": "string",
      "last_name": "string",
      "payout_email": "user@example.com",
      "links": [
        {
          "url": "string",
          "code": "string"
        }
      ],
      "promo_codes": [
        {
          "code": "string",
          "external_id": "string"
        }
      ],
      "clicks": 0,
      "approved": true,
      "banned": true,
      "details": "string",
      "new_paid_referral_notifications": true,
      "created_at": "2019-08-24T14:15:22Z",
      "campaign": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string",
        "created_at": "2019-08-24T14:15:22Z",
        "website_url": "string",
        "commission_type": "percentage",
        "commission_amount": 0,
        "is_default": true,
        "limit_type": "string",
        "limit_amount": 0,
        "code_mode": "link",
        "reference_coupon": "string",
        "custom_commission_type": "string",
        "welcome_message": "string",
        "approval_needed": true,
        "collect_details": true,
        "details_text": "string",
        "hide_emails": true,
        "dashboard_text": "string",
        "cookie_duration": 0,
        "first_payment_commission": {
          "enabled": true,
          "type": "string",
          "amount": 0
        }
      }
    }
  }
}
```
```

--------------------------------

### Get Commission by ID

Source: https://www.promotekit.com/docs/api-reference/commissions/get-commission

Retrieves a single commission by its UUID. Requires an Authorization header with a Bearer token.

```APIDOC
## GET /commissions/{id}

### Description
Retrieves a single commission by UUID.

### Method
GET

### Endpoint
/commissions/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Resource UUID. Format: "uuid"

#### Request Headers
- **Authorization** (string) - Required - Bearer <token>

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (object) - Contains the commission details.
  - **id** (string) - The unique identifier of the commission.
  - **revenue_amount** (number) - The total revenue amount.
  - **currency** (string) - The currency of the amounts.
  - **commission_amount** (number) - The calculated commission amount.
  - **payout_status** (string) - The status of the payout (e.g., "not_paid").
  - **referral_date** (string) - The date the referral occurred (ISO 8601 format).
  - **created_at** (string) - The timestamp when the commission was created (ISO 8601 format).
  - **stripe_payment_id** (string) - The ID of the associated Stripe payment.
  - **affiliate** (object) - Details about the affiliate.
  - **referral** (object) - Details about the referral.
  - **payout** (object) - Details about the payout.

#### Response Example
```json
{
  "success": true,
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "revenue_amount": 0,
    "currency": "string",
    "commission_amount": 0,
    "payout_status": "not_paid",
    "referral_date": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "stripe_payment_id": "string",
    "affiliate": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "email": "user@example.com",
      "first_name": "string",
      "last_name": "string",
      "payout_email": "user@example.com",
      "links": [
        {
          "url": "string",
          "code": "string"
        }
      ],
      "promo_codes": [
        {
          "code": "string",
          "external_id": "string"
        }
      ],
      "clicks": 0,
      "approved": true,
      "banned": true,
      "details": "string",
      "new_paid_referral_notifications": true,
      "created_at": "2019-08-24T14:15:22Z",
      "campaign": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string",
        "created_at": "2019-08-24T14:15:22Z",
        "website_url": "string",
        "commission_type": "percentage",
        "commission_amount": 0,
        "is_default": true,
        "limit_type": "string",
        "limit_amount": 0,
        "code_mode": "link",
        "reference_coupon": "string",
        "custom_commission_type": "string",
        "welcome_message": "string",
        "approval_needed": true,
        "collect_details": true,
        "details_text": "string",
        "hide_emails": true,
        "dashboard_text": "string",
        "cookie_duration": 0,
        "first_payment_commission": {
          "enabled": true,
          "type": "string",
          "amount": 0
        }
      }
    },
    "referral": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "email": "user@example.com",
      "subscription_status": "active",
      "signup_date": "2019-08-24T14:15:22Z",
      "stripe_customer_id": "string",
      "created_at": "2019-08-24T14:15:22Z"
    },
    "payout": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "affiliate_name": "string",
      "payout_email": "user@example.com",
      "amount": 0,
      "currency": "string",
      "period": "string",
      "payment_count": 0,
      "created_at": "2019-08-24T14:15:22Z"
    }
  }
}
```
Tokens:
Raw