List customers

List of customers

Pagination

Use page[number] and page[size] parameters to paginate results:

Get first page of 10 items

• GET /v1/customers?page[number]=1&page[size]=10

Get second page of 25 items

• GET /v1/customers?page[number]=2&page[size]=25

The response includes pagination links and meta data:

{
  "links": {
    "self": "https://app.kajabi.com/api/v1/customers?page[number]=2&page[size]=10",
    "first": "https://app.kajabi.com/api/v1/customers?page[number]=1&page[size]=10",
    "prev": "https://app.kajabi.com/api/v1/customers?page[number]=1&page[size]=10",
    "next": "https://app.kajabi.com/api/v1/customers?page[number]=3&page[size]=10",
    "last": "https://app.kajabi.com/api/v1/customers?page[number]=5&page[size]=10"
  },
  "meta": {
    "total_pages": 5,
    "total_count": 50,
    "current_page": 2
  }
}

Sorting

• The default Sorting is by created_at in descending order (newest first)

Sorting by created_at in ascending order (oldest first)

• GET /v1/customers?filter[site_id]=123&sort=created_at

Use the sort parameter to sort the results:

Sort by name in ascending order

• GET /v1/customers?filter[site_id]=123&sort=name

Sort by email in descending order

• GET /v1/customers?filter[site_id]=123&sort=-email

Sort by net_revenue in ascending order

• GET /v1/customers?filter[site_id]=123&sort=net_revenue

Sort by last_request_at in descending order

• GET /v1/customers?filter[site_id]=123&sort=-last_request_at

Response will include customers sorted by the specified field

{
  "data": [{
    "id": "123",
    "type": "customers",
    "attributes": {
      "name": "Alice Smith",
      "email": "alice@example.com",
      "external_user_id": "cust_123"
    }
  }]
}

Sparse Fields

Use the fields[customers] parameter to request only specific attributes:

Only return name and email attributes

• GET /v1/customers?fields[customers]=name,email

Response will only include requested fields

{
  "data": [{
    "id": "123",
    "type": "customers",
    "attributes": {
      "name": "Alice Smith",
      "email": "alice@example.com"
    }
  }]
}

Filtering

Use the filter[site_id] parameter to filter customers by site:

Get customers for site with ID 123

• GET /v1/customers?filter[site_id]=123

Response will include only customers from the specified site

{
  "data": [{
    "id": "456",
    "type": "customers",
    "attributes": {
      "name": "Alice Smith",
      "email": "alice@example.com",
      "external_user_id": "cust_123"
    },
    "relationships": {
      "site": {
        "data": {
          "id": "123",
          "type": "sites"
        }
      }
    }
  }]
}

Using Indexed Data Search

{
  "data": [{
    "id": "456",
    "type": "customers",
    "attributes": {
      "name": "John Smith",
      "email": "smith.john@example.com"
    },
    "relationships": {
      "site": {
        "data": {
          "id": "123",
          "type": "sites"
        }
      }
    }
  }]
}

Using Multiple Filters

You can combine multiple filter parameters to refine your search:

Get customers from site 123 matching search term

• GET /v1/customers?filter[site_id]=123&filter[search]=smith

Response will include only customers from the specified site matching the search term

{
  "data": [{
    "id": "456",
    "type": "customers",
    "attributes": {
      "name": "Alice Smith",
      "email": "alice@example.com",
      "external_user_id": "cust_123"
    },
    "relationships": {
      "site": {
        "data": {
          "id": "123",
          "type": "sites"
        }
      }
    }
  }]
}

Filtering by Site and Offer

You can filter customers by both site and offer ownership:

Get customers from site 123 who have been granted offer 789

• GET /v1/customers?filter[site_id]=123&filter[has_offer_id]=789

Response will include only customers from the specified site who have been granted the offer

{
  "data": [{
    "id": "456",
    "type": "customers",
    "attributes": {
      "name": "Alice Smith",
      "email": "alice@example.com",
      "external_user_id": "cust_123"
    },
    "relationships": {
      "site": {
        "data": {
          "id": "123",
          "type": "sites"
        }
      },
      "offers": {
        "links": {
          "self": "https://app.kajabi.com/api/v1/customers/456/relationships/offers",
          "related": "https://app.kajabi.com/api/v1/customers/456/offers"
        }
      }
    }
  }]
}

Filtering by Site and Product

You can filter customers by both site and product ownership:

Get customers from site 123 who have purchased product 789

• GET /v1/customers?filter[site_id]=123&filter[has_product_id]=789

Response will include only customers from the specified site who have purchased the product

{
  "data": [{
    "id": "456",
    "type": "customers",
    "attributes": {
      "name": "Alice Smith",
      "email": "alice@example.com",
      "external_user_id": "cust_123"
    },
    "relationships": {
      "site": {
        "data": {
          "id": "123",
          "type": "sites"
        }
      },
      "offers": {
        "links": {
          "self": "https://app.kajabi.com/api/v1/customers/456/relationships/offers",
          "related": "https://app.kajabi.com/api/v1/customers/456/offers"
        }
      }
    }
  }]
}

Using Multiple Parameters Together

You can combine filtering, sparse fields, pagination and search in a single request:

Get page 2 of customers from site 123, including only name and email fields, searching for “smith”

• GET /v1/customers?filter[site_id]=123&fields[customers]=name,email&page[number]=2&page[size]=10&filter[search]=smith

Response will include paginated, filtered customers with sparse fields

{
  "data": [{
    "id": "456",
    "type": "customers",
    "attributes": {
      "name": "John Smith",
      "email": "john.smith@example.com"
    }
  }],
  "links": {
    "self": "https://app.kajabi.com/api/v1/customers?filter[site_id]=123&fields[customers]=name,email&page[number]=2&page[size]=10&filter[search]=smith",
    "first": "https://app.kajabi.com/api/v1/customers?filter[site_id]=123&fields[customers]=name,email&page[number]=1&page[size]=10&filter[search]=smith",
    "prev": "https://app.kajabi.com/api/v1/customers?filter[site_id]=123&fields[customers]=name,email&page[number]=1&page[size]=10&filter[search]=smith",
    "next": null,
    "last": "https://app.kajabi.com/api/v1/customers?filter[site_id]=123&fields[customers]=name,email&page[number]=2&page[size]=10&filter[search]=smith"
  },
  "meta": {
    "total_pages": 2,
    "total_count": 15,
    "current_page": 2
  }
}