curl -X GET 'https://api.tolt.com/v1/partners?program_id=prg_YRsbPDAKhWfdqJbFACheh' \
-H 'Authorization: Bearer <API_KEY>' \
-H 'Content-Type: application/json' \
-d ''
curl -X GET 'https://api.tolt.com/v1/partners?program_id=prg_YRsbPDAKhWfdqJbFACheh&email=michael.scott@dundermifflin.com' \
-H 'Authorization: Bearer <API_KEY>' \
-H 'Content-Type: application/json' \
-d ''
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 ''
curl -X GET 'https://api.tolt.com/v1/partners?program_id=prg_YRsbPDAKhWfdqJbFACheh&expand[]=group&expand[]=program&include[]=stats' \
-H 'Authorization: Bearer <API_KEY>' \
-H 'Content-Type: application/json' \
-d ''
{
"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",
}
]
}
{
"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"
},
"stats": {
"total_clicks": 1024,
"total_customers": 112,
"total_revenue": 145000,
"total_commission": 22000
}
}
]
}
Partners
List Partners
This endpoint lists all partners.
GET
/
v1
/
partners
curl -X GET 'https://api.tolt.com/v1/partners?program_id=prg_YRsbPDAKhWfdqJbFACheh' \
-H 'Authorization: Bearer <API_KEY>' \
-H 'Content-Type: application/json' \
-d ''
curl -X GET 'https://api.tolt.com/v1/partners?program_id=prg_YRsbPDAKhWfdqJbFACheh&email=michael.scott@dundermifflin.com' \
-H 'Authorization: Bearer <API_KEY>' \
-H 'Content-Type: application/json' \
-d ''
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 ''
curl -X GET 'https://api.tolt.com/v1/partners?program_id=prg_YRsbPDAKhWfdqJbFACheh&expand[]=group&expand[]=program&include[]=stats' \
-H 'Authorization: Bearer <API_KEY>' \
-H 'Content-Type: application/json' \
-d ''
{
"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",
}
]
}
{
"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"
},
"stats": {
"total_clicks": 1024,
"total_customers": 112,
"total_revenue": 145000,
"total_commission": 22000
}
}
]
}
Base URL https://api.tolt.com
Query Parameters
string
The program ID from where you want to list the partners.
string - optional
Only return partners from this group.
string - optional
Return the partner with this exact email address (case-insensitive) within the
program. Useful for checking whether a partner already exists before creating
one. Unlike the default listing, an
email lookup also returns partners who
have not yet finished onboarding.asc | desc - optional
The order of the partners to return by created_at. Default is desc.
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.
array - optional
Specify additional related data to include in the response. Valid value is
‘stats’. Use include[]=stats.
string - optional
Only return partners created after this date.
string - optional
Only return partners created before this date.
string - optional
A limit on the number of partners to return. Default is 10, max is 100.
string - optional
A cursor for use in pagination. starting_after is an object ID that defines
your place in the list. The value of the starting_after parameter is the
partner ID. To receive the next page use the last partner ID from the previous
page.
string - optional
A cursor for use in pagination. ending_before is an object ID that defines
your place in the list. The value of the ending_before parameter is the
partner ID. To receive the previous page use the first partner ID from the
previous page.
Response
boolean
Whether the request was successful
boolean
Whether there are more pages of results available
integer
Total number of partners matching the query
array[Object]
Show properties
Show properties
string
Unique identifier for the partner,
uuid or prefixed with part_.string
Partner’s first name
string
Partner’s last name
string
Partner’s email address
string
Partner’s company name
string
Unique identifier for the program the partner belongs to,
uuid or prefixed
with prg_.string
Unique identifier for the organization,
uuid or prefixed with org_.string
Unique identifier for the partner’s group,
uuid or prefixed with grp_.string
Partner’s selected payout method (e.g., ‘paypal’, ‘crypto’, ‘wise’, ‘bank_transfer’, ‘wire’, ‘none’)
object
Details specific to the selected payout method (e.g., PayPal email, bank details)
string
Two-letter ISO country code of the partner
string
ISO 8601 timestamp of when the partner was created
string
Current status of the partner (e.g., ‘active’, ‘pending’, ‘suspended’, ‘rejected’)
object
object
Show program
Show program
Program details when expanded:
string
Unique identifier for the program
string
Program status
string
Program name
string
Name of the product
string
Program’s subdomain
string
Program type (e.g., ‘public’)
string
Three-letter ISO currency code
integer
Duration of tracking cookies in days
array
Available payout methods
string
Payment terms in days
array
Supported URL parameters for tracking
string
ISO 8601 timestamp of when the program was created
curl -X GET 'https://api.tolt.com/v1/partners?program_id=prg_YRsbPDAKhWfdqJbFACheh' \
-H 'Authorization: Bearer <API_KEY>' \
-H 'Content-Type: application/json' \
-d ''
curl -X GET 'https://api.tolt.com/v1/partners?program_id=prg_YRsbPDAKhWfdqJbFACheh&email=michael.scott@dundermifflin.com' \
-H 'Authorization: Bearer <API_KEY>' \
-H 'Content-Type: application/json' \
-d ''
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 ''
curl -X GET 'https://api.tolt.com/v1/partners?program_id=prg_YRsbPDAKhWfdqJbFACheh&expand[]=group&expand[]=program&include[]=stats' \
-H 'Authorization: Bearer <API_KEY>' \
-H 'Content-Type: application/json' \
-d ''
{
"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",
}
]
}
{
"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"
},
"stats": {
"total_clicks": 1024,
"total_customers": 112,
"total_revenue": 145000,
"total_commission": 22000
}
}
]
}
⌘I