List contacts

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

{
  "data": [
    {
      "id": "<string>",
      "type": "<string>",
      "attributes": {
        "name": "<string>",
        "email": "<string>",
        "phone_number": "<string>",
        "business_number": "<string>",
        "subscribed": true,
        "address_line_1": "<string>",
        "address_line_2": "<string>",
        "address_city": "<string>",
        "address_state": "<string>",
        "address_country": "<string>",
        "external_user_id": "<string>",
        "address_zip": "<string>",
        "custom_1": "<string>",
        "custom_2": "<string>",
        "custom_3": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "relationships": {
        "customer": {
          "data": {
            "id": "<string>",
            "type": "<string>"
          }
        },
        "offers": {
          "links": {
            "self": "<string>"
          }
        },
        "site": {
          "data": {
            "id": "<string>",
            "type": "<string>"
          }
        },
        "tags": {
          "data": [
            {
              "id": "<string>",
              "type": "<string>"
            }
          ]
        }
      },
      "links": {
        "customer": "<string>"
      }
    }
  ],
  "links": {
    "self": "<string>",
    "current": "<string>"
  }
}

Contacts

List contacts

List of contacts, we recommended filtering by site.

Filtering

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

Get contacts for site with ID 123

GET /v1/contacts?filter[site_id]=123

Response will include only contacts for the specified site

{
  "data": [{
    "id": "456",
    "type": "contacts",
    "attributes": {
      "name": "John Smith",
      "email": "john@example.com",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    },
    "relationships": {
      "site": {
        "data": {
          "id": "123",
          "type": "sites"
        }
      }
    }
  }]
}

Search Filter

Use the filter[search] parameter along with filter[site_id] to search contacts by name or email:

Search for contacts containing “smith” in site with ID 123

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

Response will include only matching contacts for the specified site

{
  "data": [{
    "id": "456",
    "type": "contacts",
    "attributes": {
      "name": "John Smith",
      "email": "smith.john@example.com",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    },
    "relationships": {
      "site": {
        "data": {
          "id": "123",
          "type": "sites"
        }
      }
    }
  }]
}

Search

Use the filter[search] parameter along with filter[site_id] to search contacts.

Search for contacts containing “smith” in site with ID 123

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

Response will include matching contacts

{
  "data": [{
    "id": "456",
    "type": "contacts",
    "attributes": {
      "name": "John Smith",
      "email": "smith.john@example.com",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    },
    "relationships": {
      "site": {
        "data": {
          "id": "123",
          "type": "sites"
        }
      }
    }
  }]
}

Using Pagination with Site Filter

Use the filter[site_id] parameter along with pagination parameters page[number] and page[size] to get paginated results for a specific site:

Get page 2 of contacts from site with ID 123, with 10 items per page

GET /v1/contacts?filter[site_id]=123&page[number]=2&page[size]=10

Response will include paginated contacts for the specified site along with pagination metadata

{
  "data": [{
    "id": "456",
    "type": "contacts",
    "attributes": {
      "name": "John Smith",
      "email": "smith.john@example.com",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    },
    "relationships": {
      "site": {
        "data": {
          "id": "123",
          "type": "sites"
        }
      }
    }
  }],
  "links": {
    "self": "https://api.kajabi.com/v1/contacts?filter[site_id]=123&page[number]=2&page[size]=10",
    "first": "https://api.kajabi.com/v1/contacts?filter[site_id]=123&page[number]=1&page[size]=10",
    "prev": "https://api.kajabi.com/v1/contacts?filter[site_id]=123&page[number]=1&page[size]=10",
    "next": "https://api.kajabi.com/v1/contacts?filter[site_id]=123&page[number]=3&page[size]=10",
    "last": "https://api.kajabi.com/v1/contacts?filter[site_id]=123&page[number]=5&page[size]=10"
  },
  "meta": {
    "total_pages": 5,
    "total_count": 50,
    "current_page": 2
  }
}

Using Sort with Site Filter

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

Sorting by created_at in ascending order (oldest first)

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

Use the sort parameter along with filter[site_id] to get sorted results for a specific site:

Get contacts from site with ID 123, sorted by name in ascending order

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

Get contacts from site with ID 123, sorted by email in descending order

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

Response will include sorted contacts for the specified site

{
  "data": [{
    "id": "456",
    "type": "contacts",
    "attributes": {
      "name": "Alice Smith",
      "email": "alice@example.com",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    },
    "relationships": {
      "site": {
        "data": {
          "id": "123",
          "type": "sites"
        }
      }
    }
  }]
}

Using Sparse Fields with Site Filter

Use the fields[contacts] parameter along with filter[site_id] to get specific fields for contacts in a site:

Get only name and email fields for contacts from site with ID 123

GET /v1/contacts?filter[site_id]=123&fields[contacts]=name,email

Response will include only requested fields for contacts in the specified site

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

Filtering by Site and Offer

Use the filter[site_id] parameter along with filter[has_offer_id] to get contacts who have been granted a specific offer

Get contacts from site with ID 123 who have been granted offer with ID 789

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

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

{
  "data": [{
    "id": "456",
    "type": "contacts",
    "attributes": {
      "name": "Alice Smith",
      "email": "alice@example.com",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    },
    "relationships": {
      "site": {
        "data": {
          "id": "123",
          "type": "sites"
        }
      }
    }
  }]
}

Filtering by Site and Tag

Use the filter[site_id] parameter along with filter[has_tag_id] to get contacts who have a specific tag

Get contacts from site with ID 123 who have tag with ID 456

GET /v1/contacts?filter[site_id]=123&filter[has_tag_id]=456

Response will include only contacts from the specified site who have the tag

{
  "data": [{
    "id": "789",
    "type": "contacts",
    "attributes": {
      "name": "Bob Jones",
      "email": "bob@example.com",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    },
    "relationships": {
      "site": {
        "data": {
          "id": "123",
          "type": "sites"
        }
      }
    }
  }]
}

Using Multiple Parameters Together

You can combine multiple parameters to filter, search, paginate and format the response:

Get paginated contacts from site 123 with tag 456, searching for “smith”, using indexed data and sparse fields

GET /v1/contacts?filter[site_id]=123&filter[has_tag_id]=456&filter[search]=smith&=true&page[number]=1&page[size]=10&fields[contacts]=name,email

Response will include paginated contacts matching all filters with only requested fields

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

GET

contacts

List contacts

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

{
  "data": [
    {
      "id": "<string>",
      "type": "<string>",
      "attributes": {
        "name": "<string>",
        "email": "<string>",
        "phone_number": "<string>",
        "business_number": "<string>",
        "subscribed": true,
        "address_line_1": "<string>",
        "address_line_2": "<string>",
        "address_city": "<string>",
        "address_state": "<string>",
        "address_country": "<string>",
        "external_user_id": "<string>",
        "address_zip": "<string>",
        "custom_1": "<string>",
        "custom_2": "<string>",
        "custom_3": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "relationships": {
        "customer": {
          "data": {
            "id": "<string>",
            "type": "<string>"
          }
        },
        "offers": {
          "links": {
            "self": "<string>"
          }
        },
        "site": {
          "data": {
            "id": "<string>",
            "type": "<string>"
          }
        },
        "tags": {
          "data": [
            {
              "id": "<string>",
              "type": "<string>"
            }
          ]
        }
      },
      "links": {
        "customer": "<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, for descending order use '-' e.g. &sort=-name

page[number]

number

page[size]

number

Number of documents

fields[contacts]

string

Sparse fields, use: name, email for example ?fields[contacts]=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 contacts created in the last N days, e.g. ?filter[created_in_last]=30

filter[not_created_in_last]

string

Filter contacts not created in the last N days

filter[is_hidden]

string

Filter hidden contacts

filter[joined_in_last]

string

Filter contacts who joined in the last N days

filter[active_in_last]

string

Filter contacts active in the last N days

filter[inactive_in_last]

string

Filter contacts inactive in the last N days

filter[name_contains]

string

Filter contacts whose name contains the given value

filter[email_contains]

string

Filter contacts whose email contains the given value

filter[phone_number_contains]

string

Filter contacts whose phone number contains the given value

filter[address_line_1_contains]

string

Filter contacts whose address line 1 contains the given value

filter[address_line_2_contains]

string

Filter contacts whose address line 2 contains the given value

filter[address_city_contains]

string

Filter contacts whose city contains the given value

filter[address_state_contains]

string

Filter contacts whose state contains the given value

filter[address_country_contains]

string

Filter contacts whose country contains the given value

filter[address_zip_contains]

string

Filter contacts whose zip code contains the given value

filter[has_tag_id]

string

Filter contacts with a specific tag ID

filter[has_all_tag_id]

string

Filter contacts with all specified tag IDs

filter[has_no_tag_id]

string

Filter contacts without the specified tag ID

filter[subscribed]

string

Filter subscribed contacts

filter[has_offer_id]

string

Filter contacts with a specific offer ID

filter[has_no_offer_id]

string

Filter contacts without the specified offer ID

filter[used_coupon_code]

string

Filter contacts who used a specific coupon code

filter[submitted_form_id]

string

Filter contacts who submitted a specific form ID

filter[no_submitted_form_id]

string

Filter contacts who have not submitted the specified form ID

filter[registered_event_id]

string

Filter contacts who registered for a specific event ID

filter[not_registered_event_id]

string

Filter contacts who have not registered for the specified event ID

filter[completed_assessment_id]

string

Filter contacts who completed a specific assessment ID

filter[passed_assessment_id]

string

Filter contacts who passed a specific assessment ID

filter[failed_assessment_id]

string

Filter contacts who failed a specific assessment ID

filter[net_revenue_equal_to]

string

Filter contacts whose net revenue equals the given value

filter[net_revenue_greater_than]

string

Filter contacts whose net revenue is greater than the given value

filter[net_revenue_less_than]

string

Filter contacts whose net revenue is less than the given value

filter[subscribed_in_last]

string

Filter contacts subscribed in the last N days

filter[unsubscribed_in_last]

string

Filter contacts unsubscribed in the last N days

filter[never_subscribed]

string

Filter contacts who have never subscribed

filter[sent_email_broadcast_id]

string

Filter contacts who were sent a specific email broadcast ID

filter[no_sent_email_broadcast_id]

string

Filter contacts who were not sent the specified email broadcast ID

filter[no_sent_email_broadcast_ids]

string

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

filter[no_delivered_email_broadcast_id]

string

Filter contacts who did not receive the specified email broadcast ID

filter[opened_email_broadcast_id]

string

Filter contacts who opened a specific email broadcast ID

filter[no_opened_email_broadcast_id]

string

Filter contacts who did not open the specified email broadcast ID

filter[clicked_email_broadcast_id]

string

Filter contacts who clicked a specific email broadcast ID

filter[no_clicked_email_broadcast_id]

string

Filter contacts who did not click the specified email broadcast ID

filter[bounced_email_broadcast_id]

string

Filter contacts who bounced a specific email broadcast ID

filter[no_bounced_email_broadcast_id]

string

Filter contacts who did not bounce the specified email broadcast ID

filter[dropped_email_broadcast_id]

string

Filter contacts who dropped a specific email broadcast ID

filter[no_dropped_email_broadcast_id]

string

Filter contacts who did not drop the specified email broadcast ID

filter[opened_email_in_last]

string

Filter contacts who opened an email in the last N days

filter[not_opened_email_in_last]

string

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

filter[delivered_email_in_last]

string

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

filter[not_delivered_email_in_last]

string

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

filter[clicked_email_in_last]

string

Filter contacts who clicked an email in the last N days

filter[not_clicked_email_in_last]

string

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

filter[is_hard_bouncing]

string

Filter contacts that are hard bouncing

filter[bounced_in_last]

string

Filter contacts who bounced in the last N days

filter[complained_in_last]

string

Filter contacts who complained in the last N days

filter[manually_unsubscribed_in_last]

string

Filter contacts manually unsubscribed in the last N days

filter[opted_out_in_last]

string

Filter contacts who opted out in the last N days

filter[healthy_contacts_with_open_data]

string

Filter healthy contacts with open data

filter[passive_contacts_with_open_data]

string

Filter passive contacts with open data

filter[unengaged_contacts_with_open_data]

string

Filter unengaged contacts with open data

filter[inactive_contacts_with_open_data]

string

Filter inactive contacts with open data

Filter contacts subscribed to a specific newsletter ID

Filter contacts unsubscribed from a specific newsletter ID

filter[is_suppressed]

string

Filter suppressed contacts

filter[mobile_phone_number_contains]

string

Filter contacts whose mobile phone number contains the given value

filter[subscribed_email_sequence_id]

string

Filter contacts subscribed to a specific email sequence ID

filter[not_subscribed_email_sequence_id]

string

Filter contacts not subscribed to a specific email sequence ID

Response

Success, list search results

data

object[]

Show child attributes

links

object

Show child attributes

Contact tag details

Create a contact