Tolt API

https://docs.tolt.com/introduction
Admin
Tolt API provides a RESTful interface to programmatically manage partnership programs, including...
Tokens:1,184
Snippets:14
Trust Score:6.5
Update:9 months ago
Show doc for...
Tokens:
Raw
### Successful Tolt API Response Example

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

Demonstrates the structure of a successful response from the Tolt API. It includes a 'success' boolean and a 'data' object containing the requested information.

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

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

### Error Tolt API Response Example

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

Illustrates the format of an error response from the Tolt API. It includes a 'success' boolean set to false and an 'error' object with a message and type.

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

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

### Tolt API Available Resources

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

An overview of the resources accessible through the Tolt API.

```APIDOC
## Available Resources

The Tolt API provides access to the following resources:

* **Partners**: Manage your partners and their information
* **Links**: Create and manage tracking links
* **Commissions**: Track and manage commission payouts
* **Transactions**: View and manage transactions
* **Promotion Codes**: Create and manage promotional codes
```

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

### Base URL for Tolt API Requests

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

The fundamental URL to interact with the Tolt API. All requests must be prefixed with this base URL.

```bash
https://api.tolt.com
```

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

### Authentication Header for Tolt API

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

Specifies how to authenticate API requests using a Bearer token. Replace '<API_KEY>' with your actual API key found in the Tolt settings.

```bash
Authorization: Bearer <API_KEY>
```

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

### Tolt API Base URL and Authentication

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

This section outlines the base URL for all API requests and the required authentication method using Bearer token.

```APIDOC
## Base URL

All API requests should be made to:

```bash
https://api.tolt.com
```

## Authentication

All API endpoints require authentication using Bearer token authentication. Include your API key in the Authorization header:

```bash
Authorization: Bearer <API_KEY>
```

You can find your API key in the [Settings -> Integrations](https://app.tolt.io/settings?tab=integrations) tab.
```

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

### Tolt API Common Parameters

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

Lists common query parameters supported by many Tolt API endpoints for pagination and data expansion.

```APIDOC
## Common Parameters

Many endpoints support these common query parameters:

* `limit`: Number of records to return (default: 10, max: 100)
* `starting_after`: Cursor for pagination (forward)
* `ending_before`: Cursor for pagination (backward)
* `expand`: Include related objects in the response
```

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

### Tolt API Response Format

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

Explains the structure of successful and error responses from the Tolt API.

```APIDOC
## Response Format

All responses are returned in JSON format and include a `success` boolean indicating if the request was successful.

### Successful Response Example

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

### Error Response Example

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