List Customers - Documentation

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

curl -X GET 'https://api.tolt.com/v1/customers?program_id=prg_YRsbPDAKhWfdqJbFACheh&expand[]=partner&expand[]=program' \
-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"
      }
    ]
  }
}

{
  "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",
        "partner": {
          "id": "part_s7mbzRGn46BhVgNFHD6fDgXW",
          "first_name": "Michael",
          "last_name": "Scott",
          "email": "michael.scott@dundermifflin.com",
          "company_name": "Dunder Mifflin",
          "status": "active",
          "created_at": "2025-01-13T10:06:11.251Z"
        },
        "program": {
          "id": "prg_YRsbPDAKhWfdqJbFACheh",
          "status": "active",
          "name": "Tolt's Partnership Program",
          "product_name": "Tolt",
          "subdomain": "affiliates",
          "type": "public",
          "currency_code": "USD",
          "created_at": "2024-03-05T10:28:08.984+00:00"
        }
      }
    ]
  }
}

GET

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

curl -X GET 'https://api.tolt.com/v1/customers?program_id=prg_YRsbPDAKhWfdqJbFACheh&expand[]=partner&expand[]=program' \
-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"
      }
    ]
  }
}

{
  "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",
        "partner": {
          "id": "part_s7mbzRGn46BhVgNFHD6fDgXW",
          "first_name": "Michael",
          "last_name": "Scott",
          "email": "michael.scott@dundermifflin.com",
          "company_name": "Dunder Mifflin",
          "status": "active",
          "created_at": "2025-01-13T10:06:11.251Z"
        },
        "program": {
          "id": "prg_YRsbPDAKhWfdqJbFACheh",
          "status": "active",
          "name": "Tolt's Partnership Program",
          "product_name": "Tolt",
          "subdomain": "affiliates",
          "type": "public",
          "currency_code": "USD",
          "created_at": "2024-03-05T10:28:08.984+00:00"
        }
      }
    ]
  }
}

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.

string - optional

Filter customers by email. Partial matches are supported.

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}

Hide properties

data

array[object]

Show properties

string

Unique identifier for the customer, uuid or prefixed with cust_

string

Your unique identifier for the customer

partner_id

string

ID of the referring partner

name

string

Customer’s name

customer_id

string

Your internal customer identifier

created_at

string

ISO 8601 timestamp of when the customer was created

updated_at

string

ISO 8601 timestamp of when the customer became active

status

string

Current status of the customer. Valid values are: ‘lead’, ‘trialing’, ‘active’, ‘canceled’

program_id

string

Program ID the customer belongs to

organization_id

string

Organization ID

partner

object

Show partner

Partner details when expanded:

string

Unique identifier for the partner

first_name

string

Partner’s first name

last_name

string

Partner’s last name

string

Partner’s email address

company_name

string

Partner’s company name

status

string

Partner’s status. Valid values are: ‘active’, ‘pending’, ‘suspended’, ‘rejected’.

created_at

string

ISO 8601 timestamp of when the partner was created

program

object

Show program

Program details when expanded:

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

currency_code

string

Three-letter ISO currency code

created_at

string

ISO 8601 timestamp of when the program was created

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

curl -X GET 'https://api.tolt.com/v1/customers?program_id=prg_YRsbPDAKhWfdqJbFACheh&expand[]=partner&expand[]=program' \
-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"
      }
    ]
  }
}

{
  "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",
        "partner": {
          "id": "part_s7mbzRGn46BhVgNFHD6fDgXW",
          "first_name": "Michael",
          "last_name": "Scott",
          "email": "michael.scott@dundermifflin.com",
          "company_name": "Dunder Mifflin",
          "status": "active",
          "created_at": "2025-01-13T10:06:11.251Z"
        },
        "program": {
          "id": "prg_YRsbPDAKhWfdqJbFACheh",
          "status": "active",
          "name": "Tolt's Partnership Program",
          "product_name": "Tolt",
          "subdomain": "affiliates",
          "type": "public",
          "currency_code": "USD",
          "created_at": "2024-03-05T10:28:08.984+00:00"
        }
      }
    ]
  }
}

Delete Partner Retrieve Customer

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

​Query Parameters

​Response

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

Query Parameters

Response