GET
/
v1
/
customers
curl -X GET 'https://api.tolt.com/v1/customers?program_id=prg_YRsbPDAKhWfdqJbFACheh' \
-H 'Authorization: Bearer <API_KEY>' \
-H 'Content-Type: application/json' \
-d ''

{
  "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-15T14:30:00.000Z",
        "status": "active",
        "program_id": "prg_YRsbPDAKhWfdqJbFACheh",
        "organization_id": "org_JE3mfYNL9ci7sFaJazAv2"
      }
    ]
  }
}

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


​
Query Parameters

​
program_id*
string

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

​
partner_id
string - optional

Only return customers referred by this partner.

​
order
asc | desc - optional

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

​
status
string - optional

Filter customers by status. Valid values are: ‘lead’, ‘trialing’, ‘active’, ‘canceled’

​
expand
array - optional

Specify which related objects to include in the response. Valid values are ‘partner’ and ‘program’. Use expand[]=partner or expand[]=program to include the related objects.

​
created_gte
string - optional

Only return customers created after this date.

​
created_lte
string - optional

Only return customers created before this date.

​
limit
string - optional

A limit on the number of customers 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 customer ID. To receive the next page use the last customer 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 customer ID. To receive the previous page use the first customer 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 customers matching the query

​
data
object{object}
curl -X GET 'https://api.tolt.com/v1/customers?program_id=prg_YRsbPDAKhWfdqJbFACheh' \
-H 'Authorization: Bearer <API_KEY>' \
-H 'Content-Type: application/json' \
-d ''

{
  "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-15T14:30:00.000Z",
        "status": "active",
        "program_id": "prg_YRsbPDAKhWfdqJbFACheh",
        "organization_id": "org_JE3mfYNL9ci7sFaJazAv2"
      }
    ]
  }
}