Tolt

https://docs.tolt.com/
Admin
Tolt is a RESTful API platform for managing partnership programs, including partners, commissions,...
Tokens:69,553
Snippets:202
Trust Score:6.5
Update:9 months ago
Show doc for...
Tokens:
Raw
### Example API Request with Curl

Source: https://docs.tolt.com/authentication

Demonstrates how to make a GET request to the /v1/links endpoint using curl. This example includes the necessary Authorization header with a sample API key. Ensure curl is installed on your system.

```bash
curl -X GET 'https://api.tolt.com/v1/links' \
-H 'Authorization: Bearer tlt_live_3eYx5GATWpBpW1bJXw4ZD9'
```

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

### Basic Partner Response Example

Source: https://docs.tolt.com/partners/retrieve

An example JSON response for a basic request to fetch partner data. It includes core partner details such as ID, name, email, and status.

```json
{
    "success": true,
    "data": {
        "id": "part_s7mbzRGn46BhVgNFHD6fDgXW",
        "first_name": "Michael",
        "last_name": "Scott",
        "email": "michael.scott@dundermifflin.com",
        "company_name": "Dunder Mifflin",
        "program_id": "prg_YRsbPDAKhWfdqJbFACheh",
        "organization_id": "org_JE3mfYNL9ci7sFaJazAv2",
        "group_id": "grp_Zc2uw9zm1eyBiD3MHcjV3RDn",
        "payout_method": "paypal",
        "payout_details": {
            "email": "michael.paypal@dundermifflin.com"
        },
        "country_code": "US",
        "created_at": "2025-01-13T10:06:11.251Z",
        "status": "active",
        "custom_fields": []
    }
}
```

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

### Create Partner Request Example (cURL)

Source: https://docs.tolt.com/partners/create

This example shows how to create a new partner using a POST request to the Tolt API. It includes the necessary headers and a JSON payload with partner details. Ensure you replace `<API_KEY>` with your actual API key.

```bash
curl -X POST 'https://api.tolt.com/v1/partners' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: application/json' \
  -d '{
      "first_name": "Michael",
      "last_name": "Scott",
      "email": "michael.scott@dundermifflin.com",
      "program_id": "prg_YRsbPDAKhWfdqJbFACheh",
      "company_name": "Dunder Mifflin",
      "country_code": "US",
      "payout_method": "paypal",
      "payout_details": {
          "email": "michael.paypal@dundermifflin.com"
      }
  }'
```

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

### Tolt API cURL Request Example

Source: https://docs.tolt.com/partners/list

Example of how to make a GET request to the Tolt API to retrieve partner information using cURL. It demonstrates the necessary headers, including authorization with an API key, and the endpoint structure with query parameters.

```bash
curl -X GET 'https://api.tolt.com/v1/partners?program_id=prg_YRsbPDAKhWfdqJbFACheh' \
  -H 'Authorization: Bearer <API_KEY>'
```

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

### Expand and Include Partner Response Example

Source: https://docs.tolt.com/partners/retrieve

An example JSON response for a partner data request that includes expanded 'group' and 'program' objects, along with 'stats'. This response provides comprehensive details about the partner and their associated group, program, and performance metrics.

```json
{
    "success": true,
    "data": {
        "id": "part_s7mbzRGn46BhVgNFHD6fDgXW",
        "first_name": "Michael",
        "last_name": "Scott",
        "email": "michael.scott@dundermifflin.com",
        "company_name": "Dunder Mifflin",
        "program_id": "prg_YRsbPDAKhWfdqJbFACheh",
        "organization_id": "org_JE3mfYNL9ci7sFaJazAv2",
        "group_id": "grp_Zc2uw9zm1eyBiD3MHcjV3RDn",
        "payout_method": "paypal",
        "payout_details": {
            "email": "michael.paypal@dundermifflin.com"
        },
        "country_code": "US",
        "created_at": "2025-01-13T10:06:11.251Z",
        "group": {
            "id": "grp_Zc2uw9zm1eyBiD3MHcjV3RDn",
            "name": "Dunder Mifflin Group",
            "description": "Dunder Mifflin Group 20% off",
            "created_at": "2024-11-25T15:24:26.846428+00:00",
            "public_key": "dunder-mifflin-group",
            "default": true
        },
        "program": {
            "id": "prg_YRsbPDAKhWfdqJbFACheh",
            "status": "active",
            "name": "Tolt's Partnership Program",
            "product_name": "Tolt",
            "subdomain": "affiliates",
            "type": "public",
            "currency_code": "USD",
            "cookie_duration": 30,
            "payout_methods": [
                "none",
                "crypto",
                "wise",
                "bank_transfer",
                "wire",
                "paypal"
            ],
            "payout_term": "15",
            "url_params": [
                "aff",
                "via"
            ],
            "created_at": "2024-03-05T10:28:08.984+00:00"
        },
        "stats": {
            "total_clicks": 40,
            "total_customers": 41,
            "total_revenue": 522226,
            "total_commission": 1741877,
            "total_leads": 11,
            "total_trial_customers": 0,
            "total_paid_customers": 23,
            "total_canceled_customers": 6
        }
    }
}
```

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

### Install Tolt.js Script (HTML)

Source: https://docs.tolt.com/javascript/overview

This snippet shows how to add the tolt.js script to the head of your website using a standard HTML script tag. Ensure you replace 'YOUR_PUBLIC_ORG_KEY' with your actual public organization key. This is the default and recommended installation method.

```html
<script
  src="https://cdn.tolt.io/tolt.js"
  data-tolt="YOUR_PUBLIC_ORG_KEY"
></script>
```

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

### Fetch LLM Documentation

Source: https://docs.tolt.com/transactions/create

This example shows how to fetch the LLM documentation file using a direct URL. This file contains navigation and other relevant pages for the LLM documentation. Ensure you have internet connectivity to access the provided URL.

```bash
curl https://docs.tolt.com/llms.txt
```

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

### Installation

Source: https://docs.tolt.com/guides/with-toltjs

Add the tolt.js script to the head of your website for click tracking.

```APIDOC
## Installation

First, add the tolt.js script to the head of your website/app:

```html
<script
  src="https://cdn.tolt.io/tolt.js"
  data-tolt="YOUR_PUBLIC_ORG_KEY"
></script>
```

Alternatively, you can dynamically create and append the script element:

```javascript
var toltScript = document.createElement('script'); 
toltScript.src = 'https://cdn.tolt.io/tolt.js'; 
toltScript.setAttribute('data-tolt', 'YOUR_PUBLIC_ORG_KEY'); 
document.head.appendChild(toltScript);
```
```

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

### Partner Creation Response Example (JSON)

Source: https://docs.tolt.com/partners/create

This JSON object represents a successful response after creating a partner. It includes a success flag and an array of partner data, detailing fields such as ID, names, email, program information, and status.

```json
{
  "success": true,
  "data": [
    {
      "id": "part_yP2D2oFyPsFUfkwzXCzRn3U2",
      "status": "active",
      "first_name": "TEST create",
      "last_name": "test",
      "company_name": null,
      "email": "aaaa@gmail.com",
      "program_id": "prg_ztTmEaAJRtfPVKM9nHhZwhjH",
      "organization_id": "org_qeHXERFhTv5DzxpvxtA5BWL5",
      "group_id": "grp_gMHPxVAQJghkdXSNXyQk6xfB",
      "created_at": "2025-08-06T13:46:07.328Z",
      "updated_at": "2025-08-06T13:46:07.328Z",
      "payout_method": "none",
      "payout_details": {},
      "country_code": null,
      "completed_onboarding": true,
      "rejection_note": null,
      "internal_note": null,
      "suspension_reason": null,
      "first_customer_email_active": true,
      "new_customer_email_active": true,
      "payout_paid_email_active": true
    }
  ]
}
```

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

### Promotion Code Response Example (JSON)

Source: https://docs.tolt.com/promotion-codes/retrieve

This is an example of a successful JSON response when retrieving a promotion code without expanded data. It includes basic information like the code, type, value, and associated IDs.

```json
{
  "success": true,
  "data": {
    "id": "prc_dK9bzRGn46BhVgNFHD6fDgXW",
    "code": "SUMMER2024",
    "type": "percentage",
    "value": 20,
    "partner_id": "part_s7mbzRGn46BhVgNFHD6fDgXW",
    "created_at": "2025-01-15T14:30:00.000Z",
    "updated_at": "2025-01-15T14:30:00.000Z",
    "program_id": "prg_YRsbPDAKhWfdqJbFACheh",
    "organization_id": "org_JE3mfYNL9ci7sFaJazAv2"
  }
}
```

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

### Fetch Partner Data with cURL

Source: https://docs.tolt.com/partners/retrieve

Demonstrates how to retrieve basic partner information using a cURL GET request. Requires an API key for authentication and specifies the partner ID in the URL.

```bash
curl -X GET 'https://api.tolt.com/v1/partners/part_s7mbzRGn46BhVgNFHD6fDgXW' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: application/json' \
  -d ''
```

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

### Update Partner Information (cURL)

Source: https://docs.tolt.com/partners/update

Example demonstrating how to update partner details using a cURL request. It specifies the HTTP method, endpoint, headers, and a JSON payload for the update.

```bash
curl -X PUT 'https://api.tolt.com/v1/partners/part_s7mbzRGn46BhVgNFHD6fDgXW' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: application/json' \
  -d '{
      "company_name": "Dunder Mifflin Paper Company",
      "payout_method": "wise",
      "payout_details": {
          "email": "michael.wise@dundermifflin.com"
      }
  }'
```

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

### Retrieve Tracking Link - cURL

Source: https://docs.tolt.com/links/retrieve

Example using cURL to retrieve a tracking link by its ID. This is a basic GET request to the specified API endpoint. Requires an Authorization header with an API key.

```bash
curl -X GET 'https://api.tolt.com/v1/links/lnk_dK9bzRGn46BhVgNFHD6fDgXW' \
  -H 'Authorization: Bearer <API_KEY>'
```

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

### Tolt API Successful Response Example

Source: https://docs.tolt.com/index

An example of a successful API response from Tolt. Successful responses include a 'success' boolean set to true and a 'data' object containing the requested information.

```json
{
  "success": true,
  "data": {
    "id": "part_s7mbzRGn46BhVgNFHD6fDgXW",
    "first_name": "Michael",
    "last_name": "Scott"
    // ... other fields
  }
}
```

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

### Create Click via Tracking Parameter (Bash)

Source: https://docs.tolt.com/clicks/create

This code snippet illustrates how to create a click record by specifying a tracking parameter and its value. It uses a POST request to the Tolt API, including authentication and a JSON body with the parameter name, value, and other click details like country, device, page, and referrer. Remember to substitute `<API_KEY>` with your valid API key.

```bash
curl -X POST 'https://api.tolt.com/v1/clicks' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: application/json' \
  -d '{
      "param": "ref",
      "value": "michael_scott",
      "country": "US",
      "device": "mobile",
      "page": "https://example.com/product",
      "referrer": "https://twitter.com"
  }'
```

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

### Delete Transaction Request Example (cURL)

Source: https://docs.tolt.com/transactions/delete

This example demonstrates how to delete a transaction using a cURL command. It requires the transaction ID and an API key for authorization. The endpoint is part of the v1 transactions API.

```bash
curl -X DELETE 'https://api.tolt.com/v1/transactions/txn_eK9bzRGn46BhVgNFHD6fDgXW' \
  -H 'Authorization: Bearer <API_KEY>'
```

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

### Tolt API Error Response Example

Source: https://docs.tolt.com/index

An example of an error response from the Tolt API. Error responses include a 'success' boolean set to false and an 'error' object with details about the error, including a message and type.

```json
{
  "success": false,
  "error": {
    "message": "Invalid API key provided",
    "type": "authentication_error"
  }
}
```

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

### Create Commission Request Example (cURL)

Source: https://docs.tolt.com/commissions/create

This cURL command demonstrates how to create a new commission by sending a POST request to the Tolt API. It includes necessary headers for authorization and content type, along with a JSON payload containing commission details such as amount, customer ID, transaction ID, and status. Ensure you replace '<API_KEY>' with your actual API key.

```bash
curl -X POST 'https://api.tolt.com/v1/commissions' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: application/json' \
  -d '{
      "amount": 1999,
      "customer_id": "cust_dK9bzRGn46BhVgNFHD6fDgXW",
      "transaction_id": "txn_7mbzRGn46BhVgNFHD6fDgXW",
      "charge_id": "ch_9bzRGn46BhVgNFHD6fDgXW",
      "source": "stripe",
      "status": "pending",
      "revenue": 9999,
      "created_at": "2025-01-15T14:30:00.000Z"
  }'
```

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

### Fetch Customer with Expand & Include (cURL)

Source: https://docs.tolt.com/customers/retrieve

This cURL command shows how to retrieve customer details along with expanded partner and included program statistics. The `expand[]` and `include[]` query parameters are used to specify related resources to be included in the response. An API key is required for authentication.

```bash
curl -X GET 'https://api.tolt.com/v1/customers/cust_dK9bzRGn46BhVgNFHD6fDgXW?expand[]=partner&expand[]=program&include[]=stats' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: application/json' \
  -d ''
```

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

### Create Click via Partner ID (Bash)

Source: https://docs.tolt.com/clicks/create

This code snippet demonstrates how to create a click record using a partner ID. It sends a POST request to the Tolt API with authentication headers and a JSON payload containing click details such as partner ID, link ID, country, device, page URL, and referrer. Ensure you replace `<API_KEY>` with your actual API key.

```bash
curl -X POST 'https://api.tolt.com/v1/clicks' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: application/json' \
  -d '{
      "partner_id": "part_s7mbzRGn46BhVgNFHD6fDgXW",
      "link_id": "lnk_dK9bzRGn46BhVgNFHD6fDgXW",
      "country": "US",
      "device": "desktop",
      "page": "https://example.com/product",
      "referrer": "https://google.com"
  }'
```

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

### GET /v1/partners

Source: https://docs.tolt.com/partners/list

Retrieves a list of partners associated with a specific program. Supports filtering and pagination.

```APIDOC
## GET /v1/partners

### Description
Retrieves a list of partners associated with a specific program. Supports filtering and pagination.

### Method
GET

### Endpoint
/v1/partners

### Query Parameters
- **program_id** (string) - Required - The unique identifier for the program.

### Request Example
```bash cURL
curl -X GET 'https://api.tolt.com/v1/partners?program_id=prg_YRsbPDAKhWfdqJbFACheh' \
-H 'Authorization: Bearer <API_KEY>'
```

### Response
#### Success Response (200)
- **success** (boolean) - Whether the request was successful.
- **has_more** (boolean) - Whether there are more pages of results available.
- **total_count** (integer) - Total number of partners matching the query.
- **data** (array[Object]) - An array of partner objects.
  - **id** (string) - Unique identifier for the partner, `uuid` or prefixed with `part_`.
  - **first_name** (string) - Partner's first name.
  - **last_name** (string) - Partner's last name.
  - **email** (string) - Partner's email address.
  - **company_name** (string) - Partner's company name.
  - **program_id** (string) - Unique identifier for the program the partner belongs to, `uuid` or prefixed with `prg_`.
  - **organization_id** (string) - Unique identifier for the organization, `uuid` or prefixed with `org_`.
  - **group_id** (string) - Unique identifier for the partner's group, `uuid` or prefixed with `grp_`.
  - **payout_method** (string) - Partner's selected payout method (e.g., 'paypal', 'crypto', 'wise', 'bank_transfer', 'wire', 'none').
  - **payout_details** (object) - Details specific to the selected payout method (e.g., PayPal email, bank details).
  - **country_code** (string) - Two-letter ISO country code of the partner.
  - **created_at** (string) - ISO 8601 timestamp of when the partner was created.
  - **status** (string) - Current status of the partner (e.g., 'active', 'pending', 'suspended', 'rejected').
  - **group** (object) - Group details.
    - **id** (string) - Unique identifier for the group.
    - **name** (string) - Name of the group.
    - **description** (string) - Description of the group.
    - **created_at** (string) - ISO 8601 timestamp of when the group was created.
    - **public_key** (string) - Public identifier for the group.
    - **default** (boolean) - Whether this is the default group.
  - **program** (object) - Program details.
    - **id** (string) - Unique identifier for the program.
    - **status** (string) - Program status.
    - **name** (string) - Program name.
    - **product_name** (string) - Name of the product.
    - **subdomain** (string) - Program's subdomain.
    - **type** (string) - Program type (e.g., 'public').
    - **currency_code** (string) - Three-letter ISO currency code.
    - **cookie_duration** (integer) - Duration of tracking cookies in days.
    - **payout_methods** (array) - Available payout methods.
    - **payout_term** (string) - Payment terms in days.
    - **url_params** (array) - Supported URL parameters for tracking.
    - **created_at** (string) - ISO 8601 timestamp of when the program was created.

#### Response Example
```json
{
  "success": true,
  "has_more": false,
  "total_count": 1,
  "data": [
    {
      "id": "part_aBcDeFgHiJkLmNoPqRsT",
      "first_name": "Jane",
      "last_name": "Doe",
      "email": "jane.doe@example.com",
      "company_name": "Example Corp",
      "program_id": "prg_YRsbPDAKhWfdqJbFACheh",
      "organization_id": "org_12345",
      "group_id": "grp_67890",
      "payout_method": "paypal",
      "payout_details": {
        "email": "jane.doe@example.com"
      },
      "country_code": "US",
      "created_at": "2023-10-27T10:00:00Z",
      "status": "active",
      "group": {
        "id": "grp_67890",
        "name": "Default Group",
        "description": "The main group for partners.",
        "created_at": "2023-01-01T00:00:00Z",
        "public_key": "pk_abc123",
        "default": true
      },
      "program": {
        "id": "prg_YRsbPDAKhWfdqJbFACheh",
        "status": "active",
        "name": "Example Program",
        "product_name": "Example Product",
        "subdomain": "example",
        "type": "public",
        "currency_code": "USD",
        "cookie_duration": 30,
        "payout_methods": ["paypal", "bank_transfer"],
        "payout_term": "net_30",
        "url_params": ["ref", "source"],
        "created_at": "2023-01-01T00:00:00Z"
      }
    }
  ]
}
```
```

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

### Install Tolt.js Script (JavaScript)

Source: https://docs.tolt.com/javascript/overview

This snippet demonstrates how to dynamically create and append the tolt.js script to the document's head using JavaScript. This alternative method is useful if you need more control over script loading or want to load it conditionally. Replace 'YOUR_PUBLIC_ORG_KEY' with your actual public organization key.

```javascript
var toltScript = document.createElement('script'); 
toltScript.src = 'https://cdn.tolt.io/tolt.js'; 
toltScript.setAttribute('data-tolt', 'YOUR_PUBLIC_ORG_KEY'); 
document.head.appendChild(toltScript);
```

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

### GET /websites/tolt/customers

Source: https://docs.tolt.com/customers/list

Retrieves a list of customers associated with the Tolt website. Supports pagination and filtering.

```APIDOC
## GET /websites/tolt/customers

### Description
Retrieves a list of customers associated with the Tolt website. Supports pagination and filtering.

### Method
GET

### Endpoint
/websites/tolt/customers

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of customers to return per page.
- **offset** (integer) - Optional - The number of customers to skip before starting to collect the result set.
- **sort** (string) - Optional - Specifies the field to sort by. Use a hyphen for descending order (e.g., `created_at` or `-created_at`).

### Request Example
```http
GET /websites/tolt/customers?limit=10&offset=0
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **has_more** (boolean) - Indicates if there are more results available.
- **total_count** (integer) - The total number of customers matching the query.
- **data** (object) - Contains the list of customer data.
  - **data** (array) - An array of customer objects.
    - **id** (string) - Unique identifier for the customer.
    - **email** (string) - Customer's email address.
    - **partner_id** (string) - Identifier of the partner associated with the customer.
    - **name** (string) - Customer's full name.
    - **customer_id** (string) - A unique, human-readable identifier for the customer.
    - **created_at** (string) - Timestamp of when the customer was created (ISO 8601 format).
    - **updated_at** (string) - Timestamp of when the customer was last updated (ISO 8601 format).
    - **status** (string) - Current status of the customer (e.g., 'active', 'inactive').
    - **program_id** (string) - Identifier of the program the customer is associated with.
    - **organization_id** (string) - Identifier of the organization the customer belongs to.

#### Response Example
```json
{
  "success": true,
  "has_more": true,
  "total_count": 85,
  "data": {
    "data": [
      {
        "id": "cust_dK9bzRGn46BhVgNFHD6fDgXW",
        "email": "customer@example.com",
        "partner_id": "part_s7mbzRGn46BhVgNFHD6fDgXW",
        "name": "Jim Halpert",
        "customer_id": "jim_halpert_789",
        "created_at": "2025-01-15T14:30:00.000Z",
        "updated_at": "2025-01-15T15:00:00.000Z",
        "status": "active",
        "program_id": "prg_YRsbPDAKhWfdqJbFACheh",
        "organization_id": "org_JE3mfYNL9ci7sFaJazAv2"
      }
    ]
  }
}
```

#### Error Response (4xx, 5xx)
- **success** (boolean) - Indicates if the request was successful.
- **error** (object) - Contains error details.
  - **code** (string) - Error code.
  - **message** (string) - Error message.
```

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

### Fetch Commissions (cURL)

Source: https://docs.tolt.com/commissions/list

This cURL command demonstrates how to fetch a list of commissions from the Tolt API. It requires an API key for authentication and can filter results by `program_id`. The response includes success status, pagination information, total count, and an array of commission data.

```bash
curl -X GET 'https://api.tolt.com/v1/commissions?program_id=prg_YRsbPDAKhWfdqJbFACheh' \
  -H 'Authorization: Bearer <API_KEY>'
```

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

### GET /websites/tolt

Source: https://docs.tolt.com/partners/retrieve

Retrieves partner information, with options to include related data like group, program, and statistics.

```APIDOC
## GET /websites/tolt

### Description
This endpoint retrieves a partner.

### Method
GET

### Endpoint
https://api.tolt.com/websites/tolt

### Parameters
#### Query Parameters
- **expand** (array - optional) - Specify which related objects to include in the response. Valid values are 'group' and 'program'. Use expand[]=group or expand[]=program to include the related objects.
- **include** (array - optional) - Specify which related objects to include in the response. Valid values are 'stats'. Use include[]=stats to include the related objects.

### Request Example
```json
{
  "example": "GET https://api.tolt.com/websites/tolt?expand[]=group&include[]=stats"
}
```

### Response
#### Success Response (200)
- **partner_data** (object) - Contains the partner's information.
- **related_objects** (object) - Contains expanded or included related objects if requested.

#### Response Example
```json
{
  "example": {
    "partner_data": {
      "id": "partner_123",
      "name": "Example Partner",
      "email": "partner@example.com"
    },
    "related_objects": {
      "group": {
        "id": "group_abc",
        "name": "Example Group"
      },
      "stats": {
        "total_sales": 1000,
        "active_users": 50
      }
    }
  }
}
```
```

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

### Fetch Partner Data with Expand and Include using cURL

Source: https://docs.tolt.com/partners/retrieve

Shows how to fetch partner data and include related resources like 'group' and 'program', as well as statistics. This request uses the 'expand' and 'include' query parameters to enrich the response. Requires an API key for authentication.

```bash
curl -X GET 'https://api.tolt.com/v1/partners/part_s7mbzRGn46BhVgNFHD6fDgXW&expand[]=group&expand[]=program&include[]=stats' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: application/json' \
  -d ''
```

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

### Get Links with Expanded Partner and Program Data - cURL Request

Source: https://docs.tolt.com/links/list

This cURL command retrieves links and includes expanded details for associated partners and programs. By adding `expand[]=partner` and `expand[]=program` to the query parameters, the API returns richer contextual information for each link. Authentication with an API key is required.

```bash
curl -X GET 'https://api.tolt.com/v1/links?program_id=prg_YRsbPDAKhWfdqJbFACheh&expand[]=partner&expand[]=program' \
  -H 'Authorization: Bearer <API_KEY>'
```

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

### GET /v1/partners

Source: https://docs.tolt.com/partners/list

Retrieves a list of partners associated with a program. Supports expanding related group and program details.

```APIDOC
## GET /v1/partners

### Description
Retrieves a list of partners. This endpoint allows filtering by program ID and expanding related data such as group and program details.

### Method
GET

### Endpoint
`/v1/partners`

### Parameters
#### Query Parameters
- **program_id** (string) - Required - The ID of the program to filter partners by.
- **expand[]** (string) - Optional - Specifies related data to include in the response. Can be `group` or `program`.

### Request Example
```bash
curl -X GET 'https://api.tolt.com/v1/partners?program_id=prg_YRsbPDAKhWfdqJbFACheh&expand[]=group&expand[]=program' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: application/json' \
  -d ''
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **has_more** (boolean) - Indicates if there are more results available.
- **total_count** (integer) - The total number of partners found.
- **data** (array) - An array of partner objects.
  - **id** (string) - The unique identifier for the partner.
  - **first_name** (string) - The first name of the partner.
  - **last_name** (string) - The last name of the partner.
  - **email** (string) - The email address of the partner.
  - **company_name** (string) - The company name of the partner.
  - **program_id** (string) - The ID of the program the partner belongs to.
  - **organization_id** (string) - The ID of the organization.
  - **group_id** (string) - The ID of the group the partner belongs to.
  - **payout_method** (string) - The partner's preferred payout method.
  - **payout_details** (object) - Details for the payout method.
    - **email** (string) - Email for PayPal payout.
  - **country_code** (string) - The country code of the partner.
  - **created_at** (string) - The timestamp when the partner was created.
  - **group** (object) - (Optional, if `expand[]=group` is used) Detailed information about the partner's group.
    - **id** (string) - The unique identifier for the group.
    - **name** (string) - The name of the group.
    - **description** (string) - A description of the group.
    - **created_at** (string) - The timestamp when the group was created.
    - **public_key** (string) - A public key associated with the group.
    - **default** (boolean) - Indicates if this is the default group.
  - **program** (object) - (Optional, if `expand[]=program` is used) Detailed information about the partner's program.
    - **id** (string) - The unique identifier for the program.
    - **status** (string) - The current status of the program.
    - **name** (string) - The name of the program.
    - **product_name** (string) - The name of the product associated with the program.
    - **subdomain** (string) - The subdomain for the program.
    - **type** (string) - The type of the program.
    - **currency_code** (string) - The currency code for the program.
    - **cookie_duration** (integer) - The duration of the tracking cookie in days.
    - **payout_methods** (array) - A list of supported payout methods.
    - **payout_term** (string) - The payout term.
    - **url_params** (array) - URL parameters used for tracking.
    - **created_at** (string) - The timestamp when the program was created.

#### Response Example
```json
{
    "success": true,
    "has_more": true,
    "total_count": 160,
    "data": [
        {
            "id": "part_s7mbzRGn46BhVgNFHD6fDgXW",
            "first_name": "Michael",
            "last_name": "Scott",
            "email": "michael.scott@dundermifflin.com",
            "company_name": "Dunder Mifflin",
            "program_id": "prg_YRsbPDAKhWfdqJbFACheh",
            "organization_id": "org_JE3mfYNL9ci7sFaJazAv2",
            "group_id": "grp_Zc2uw9zm1eyBiD3MHcjV3RDn",
            "payout_method": "paypal",
            "payout_details": {
                "email": "michael.paypal@dundermifflin.com"
            },
            "country_code": "US",
            "created_at": "2025-01-13T10:06:11.251Z",
            "group": {
                "id": "grp_Zc2uw9zm1eyBiD3MHcjV3RDn",
                "name": "Dunder Mifflin Group",
                "description": "Dunder Mifflin Group 20% off",
                "created_at": "2024-11-25T15:24:26.846428+00:00",
                "public_key": "dunder-mifflin-group",
                "default": true
            },
            "program": {
                "id": "prg_YRsbPDAKhWfdqJbFACheh",
                "status": "active",
                "name": "Tolt's Partnership Program",
                "product_name": "Tolt",
                "subdomain": "affiliates",
                "type": "public",
                "currency_code": "USD",
                "cookie_duration": 30,
                "payout_methods": [
                    "none",
                    "crypto",
                    "wise",
                    "bank_transfer",
                    "wire",
                    "paypal"
                ],
                "payout_term": "15",
                "url_params": [
                    "aff",
                    "via"
                ],
                "created_at": "2024-03-05T10:28:08.984+00:00"
            }
        }
    ]
}
```
```

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

### GET /v1/partners/{partner_id}

Source: https://docs.tolt.com/partners/retrieve

Retrieves detailed information about a specific partner, including their profile, group, program, and performance statistics.

```APIDOC
## GET /v1/partners/{partner_id}

### Description
Retrieves detailed information about a specific partner, including their profile, group, program, and performance statistics. Supports expanding related resources like 'group' and 'program', and including 'stats'.

### Method
GET

### Endpoint
`/v1/partners/{partner_id}`

### Parameters
#### Path Parameters
- **partner_id** (string) - Required - The unique identifier of the partner.

#### Query Parameters
- **expand** (array of strings) - Optional - Resources to expand. Allowed values: `group`, `program`.
- **include** (array of strings) - Optional - Resources to include. Allowed values: `stats`.

### Request Example
```bash
curl -X GET 'https://api.tolt.com/v1/partners/part_s7mbzRGn46BhVgNFHD6fDgXW' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: application/json' \
  -d ''
```

```bash
curl -X GET 'https://api.tolt.com/v1/partners/part_s7mbzRGn46BhVgNFHD6fDgXW&expand[]=group&expand[]=program&include[]=stats' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: application/json' \
  -d ''
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (object) - Contains the partner's information.
  - **id** (string) - Partner's unique identifier.
  - **first_name** (string) - Partner's first name.
  - **last_name** (string) - Partner's last name.
  - **email** (string) - Partner's email address.
  - **company_name** (string) - Partner's company name.
  - **program_id** (string) - The ID of the program the partner is associated with.
  - **organization_id** (string) - The ID of the organization the partner belongs to.
  - **group_id** (string) - The ID of the group the partner is associated with.
  - **payout_method** (string) - The partner's preferred payout method.
  - **payout_details** (object) - Details for the selected payout method.
  - **country_code** (string) - The partner's country code.
  - **created_at** (string) - Timestamp of when the partner was created.
  - **status** (string) - The current status of the partner.
  - **custom_fields** (array) - Custom fields associated with the partner.
  - **group** (object) - (Optional, if `expand[]=group` is used) Details of the partner's group.
  - **program** (object) - (Optional, if `expand[]=program` is used) Details of the partner's program.
  - **stats** (object) - (Optional, if `include[]=stats` is used) Performance statistics for the partner.
    - **total_clicks** (integer) - Total number of clicks.
    - **total_customers** (integer) - Total number of customers.
    - **total_revenue** (integer) - Total revenue generated.
    - **total_commission** (integer) - Total commission earned.
    - **total_leads** (integer) - Total number of leads.
    - **total_trial_customers** (integer) - Total number of trial customers.
    - **total_paid_customers** (integer) - Total number of paid customers.
    - **total_canceled_customers** (integer) - Total number of customers who canceled.

#### Response Example
```json
{
    "success": true,
    "data": {
        "id": "part_s7mbzRGn46BhVgNFHD6fDgXW",
        "first_name": "Michael",
        "last_name": "Scott",
        "email": "michael.scott@dundermifflin.com",
        "company_name": "Dunder Mifflin",
        "program_id": "prg_YRsbPDAKhWfdqJbFACheh",
        "organization_id": "org_JE3mfYNL9ci7sFaJazAv2",
        "group_id": "grp_Zc2uw9zm1eyBiD3MHcjV3RDn",
        "payout_method": "paypal",
        "payout_details": {
            "email": "michael.paypal@dundermifflin.com"
        },
        "country_code": "US",
        "created_at": "2025-01-13T10:06:11.251Z",
        "status": "active",
        "custom_fields": [],
        "group": {
            "id": "grp_Zc2uw9zm1eyBiD3MHcjV3RDn",
            "name": "Dunder Mifflin Group",
            "description": "Dunder Mifflin Group 20% off",
            "created_at": "2024-11-25T15:24:26.846428+00:00",
            "public_key": "dunder-mifflin-group",
            "default": true
        },
        "program": {
            "id": "prg_YRsbPDAKhWfdqJbFACheh",
            "status": "active",
            "name": "Tolt's Partnership Program",
            "product_name": "Tolt",
            "subdomain": "affiliates",
            "type": "public",
            "currency_code": "USD",
            "cookie_duration": 30,
            "payout_methods": [
                "none",
                "crypto",
                "wise",
                "bank_transfer",
                "wire",
                "paypal"
            ],
            "payout_term": "15",
            "url_params": [
                "aff",
                "via"
            ],
            "created_at": "2024-03-05T10:28:08.984+00:00"
        },
        "stats": {
            "total_clicks": 40,
            "total_customers": 41,
            "total_revenue": 522226,
            "total_commission": 1741877,
            "total_leads": 11,
            "total_trial_customers": 0,
            "total_paid_customers": 23,
            "total_canceled_customers": 6
        }
    }
}
```
```
Tokens:
Raw