List customers

curl --request GET \
  --url https://api.kajabi.com/v1/customers \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "<string>",
      "type": "<string>",
      "attributes": {
        "name": "<string>",
        "email": "<string>",
        "avatar": "<string>",
        "external_user_id": "<string>",
        "public_bio": "<string>",
        "public_location": "<string>",
        "public_website": "<string>",
        "socials": {
          "twitter": "<string>",
          "facebook": "<string>",
          "instagram": "<string>"
        },
        "net_revenue": "<string>",
        "sign_in_count": 123,
        "last_request_at": "<string>",
        "bounced_at": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "relationships": {
        "contact": {
          "data": {
            "id": "<string>",
            "type": "<string>"
          }
        },
        "site": {
          "data": {
            "id": "<string>",
            "type": "<string>"
          }
        },
        "offers": {
          "links": {
            "self": "<string>"
          }
        },
        "products": {
          "data": [
            {
              "id": "<string>",
              "type": "<string>"
            }
          ]
        }
      },
      "links": {
        "contact": "<string>"
      }
    }
  ],
  "links": {
    "self": "<string>",
    "current": "<string>"
  }
}

Customers

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: ```json { "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 ```json { "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 ```json { "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 ```json { "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 ```json { "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 ```json { "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 ```json { "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 ```json { "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 } } ```

GET

customers

List customers

curl --request GET \
  --url https://api.kajabi.com/v1/customers \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "<string>",
      "type": "<string>",
      "attributes": {
        "name": "<string>",
        "email": "<string>",
        "avatar": "<string>",
        "external_user_id": "<string>",
        "public_bio": "<string>",
        "public_location": "<string>",
        "public_website": "<string>",
        "socials": {
          "twitter": "<string>",
          "facebook": "<string>",
          "instagram": "<string>"
        },
        "net_revenue": "<string>",
        "sign_in_count": 123,
        "last_request_at": "<string>",
        "bounced_at": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "relationships": {
        "contact": {
          "data": {
            "id": "<string>",
            "type": "<string>"
          }
        },
        "site": {
          "data": {
            "id": "<string>",
            "type": "<string>"
          }
        },
        "offers": {
          "links": {
            "self": "<string>"
          }
        },
        "products": {
          "data": [
            {
              "id": "<string>",
              "type": "<string>"
            }
          ]
        }
      },
      "links": {
        "contact": "<string>"
      }
    }
  ],
  "links": {
    "self": "<string>",
    "current": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

sort

string

Sort order, use: name, email, created_at, net_revenue, last_request_at for descending order use '-' e.g. &sort=-name

page[number]

number

page[size]

number

Number of documents

fields[customers]

string

Sparse fields, use: name, email for example ?fields[customers]=name,email

filter[site_id]

string

It is recommended to always filter by site_id, for example ?filter[site_id]=111. This param is required when the account has multiple sites

filter[search]

string

Filter with fuzzy search of name/email, for example ?filter[search]=alexa

filter[created_in_last]

string

Filter customers created in the last N days, e.g. ?filter[created_in_last]=30

filter[not_created_in_last]

string

Filter customers not created in the last N days

filter[is_hidden]

string

Filter hidden customers

filter[joined_in_last]

string

Filter customers who joined in the last N days

filter[active_in_last]

string

Filter customers active in the last N days

filter[inactive_in_last]

string

Filter customers inactive in the last N days

filter[name_contains]

string

Filter customers whose name contains the given value

filter[email_contains]

string

Filter customers whose email contains the given value

filter[phone_number_contains]

string

Filter customers whose phone number contains the given value

filter[address_line_1_contains]

string

Filter customers whose address line 1 contains the given value

filter[address_line_2_contains]

string

Filter customers whose address line 2 contains the given value

filter[address_city_contains]

string

Filter customers whose city contains the given value

filter[address_state_contains]

string

Filter customers whose state contains the given value

filter[address_country_contains]

string

Filter customers whose country contains the given value

filter[address_zip_contains]

string

Filter customers whose zip code contains the given value

filter[has_tag_id]

string

Filter customers with a specific tag ID

filter[has_all_tag_id]

string

Filter customers with all specified tag IDs

filter[has_no_tag_id]

string

Filter customers without the specified tag ID

filter[subscribed]

string

Filter subscribed customers

filter[has_offer_id]

string

Filter customers with a specific offer ID

filter[has_no_offer_id]

string

Filter customers without the specified offer ID

filter[used_coupon_code]

string

Filter customers who used a specific coupon code

filter[submitted_form_id]

string

Filter customers who submitted a specific form ID

filter[no_submitted_form_id]

string

Filter customers who have not submitted the specified form ID

filter[registered_event_id]

string

Filter customers who registered for a specific event ID

filter[not_registered_event_id]

string

Filter customers who have not registered for the specified event ID

filter[completed_assessment_id]

string

Filter customers who completed a specific assessment ID

filter[passed_assessment_id]

string

Filter customers who passed a specific assessment ID

filter[failed_assessment_id]

string

Filter customers who failed a specific assessment ID

filter[net_revenue_equal_to]

string

Filter customers whose net revenue equals the given value

filter[net_revenue_greater_than]

string

Filter customers whose net revenue is greater than the given value

filter[net_revenue_less_than]

string

Filter customers whose net revenue is less than the given value

filter[subscribed_in_last]

string

Filter customers subscribed in the last N days

filter[unsubscribed_in_last]

string

Filter customers unsubscribed in the last N days

filter[never_subscribed]

string

Filter customers who have never subscribed

filter[sent_email_broadcast_id]

string

Filter customers who were sent a specific email broadcast ID

filter[no_sent_email_broadcast_id]

string

Filter customers who were not sent the specified email broadcast ID

filter[no_sent_email_broadcast_ids]

string

Filter customers who were not sent any of the specified email broadcast IDs

filter[no_delivered_email_broadcast_id]

string

Filter customers who did not receive the specified email broadcast ID

filter[opened_email_broadcast_id]

string

Filter customers who opened a specific email broadcast ID

filter[no_opened_email_broadcast_id]

string

Filter customers who did not open the specified email broadcast ID

filter[clicked_email_broadcast_id]

string

Filter customers who clicked a specific email broadcast ID

filter[no_clicked_email_broadcast_id]

string

Filter customers who did not click the specified email broadcast ID

filter[bounced_email_broadcast_id]

string

Filter customers who bounced a specific email broadcast ID

filter[no_bounced_email_broadcast_id]

string

Filter customers who did not bounce the specified email broadcast ID

filter[dropped_email_broadcast_id]

string

Filter customers who dropped a specific email broadcast ID

filter[no_dropped_email_broadcast_id]

string

Filter customers who did not drop the specified email broadcast ID

filter[opened_email_in_last]

string

Filter customers who opened an email in the last N days

filter[not_opened_email_in_last]

string

Filter customers who did not open an email in the last N days

filter[delivered_email_in_last]

string

Filter customers who were delivered an email in the last N days

filter[not_delivered_email_in_last]

string

Filter customers who were not delivered an email in the last N days

filter[clicked_email_in_last]

string

Filter customers who clicked an email in the last N days

filter[not_clicked_email_in_last]

string

Filter customers who did not click an email in the last N days

filter[is_hard_bouncing]

string

Filter customers that are hard bouncing

filter[bounced_in_last]

string

Filter customers who bounced in the last N days

filter[complained_in_last]

string

Filter customers who complained in the last N days

filter[manually_unsubscribed_in_last]

string

Filter customers manually unsubscribed in the last N days

filter[opted_out_in_last]

string

Filter customers who opted out in the last N days

filter[healthy_contacts_with_open_data]

string

Filter healthy customers with open data

filter[passive_contacts_with_open_data]

string

Filter passive customers with open data

filter[unengaged_contacts_with_open_data]

string

Filter unengaged customers with open data

filter[inactive_contacts_with_open_data]

string

Filter inactive customers with open data

Filter customers subscribed to a specific newsletter ID

Filter customers unsubscribed from a specific newsletter ID

filter[is_suppressed]

string

Filter suppressed customers

filter[mobile_phone_number_contains]

string

Filter customers whose mobile phone number contains the given value

filter[subscribed_email_sequence_id]

string

Filter customers subscribed to a specific email sequence ID

filter[not_subscribed_email_sequence_id]

string

Filter customers not subscribed to a specific email sequence ID

Response

Success, list search results

data

object[]

Show child attributes

links

object

Show child attributes

Custom field details

Customer details

Getting Started

Authentication

Sites

Contact Notes

Contact Tags

Contacts

Products

Custom Fields

Customers

Forms

Webhooks

Me

Offers

Orders

Purchases

Transactions

Version

List customers

Authorizations

Query Parameters

Response