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 ''

{
    "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",
        }
    ]
}

​
Base URL https://api.tolt.com


​
Query Parameters

​
program_id*
string

The program ID from where you want to list the partners.

​
group_id
string - optional

Only return partners from this group.

​
order
asc | desc - optional

The order of the partners to return by created_at. Default is desc.

​
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.

​
created_gte
string - optional

Only return partners created after this date.

​
created_lte
string - optional

Only return partners created before this date.

​
limit
string - optional

A limit on the number of partners to return. Default is 10, max is 100.

​
starting_after
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.

​
ending_before
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

​
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]
curl -X GET 'https://api.tolt.com/v1/partners?program_id=prg_YRsbPDAKhWfdqJbFACheh' \
-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",
        }
    ]
}