{ "summary": "List contacts", "description": "List of contacts, we recommended filtering by site.\n\n## Filtering\nUse the `filter[site_id]` parameter to filter contacts by site:\n\n### Get contacts for site with ID 123\n* `GET /v1/contacts?filter[site_id]=123`\n\nResponse will include only contacts for the specified site\n```json\n{\n \"data\": [{\n \"id\": \"456\",\n \"type\": \"contacts\",\n \"attributes\": {\n \"name\": \"John Smith\",\n \"email\": \"john@example.com\",\n \"created_at\": \"2024-01-15T10:30:00Z\",\n \"updated_at\": \"2024-01-15T10:30:00Z\"\n },\n \"relationships\": {\n \"site\": {\n \"data\": {\n \"id\": \"123\",\n \"type\": \"sites\"\n }\n }\n }\n }]\n}\n```\n## Search Filter\nUse the `filter[search]` parameter along with `filter[site_id]` to search contacts by name or email:\n\n### Search for contacts containing \"smith\" in site with ID 123\n* `GET /v1/contacts?filter[site_id]=123&filter[search]=smith`\n\nResponse will include only matching contacts for the specified site\n```json\n{\n \"data\": [{\n \"id\": \"456\",\n \"type\": \"contacts\",\n \"attributes\": {\n \"name\": \"John Smith\",\n \"email\": \"smith.john@example.com\",\n \"created_at\": \"2024-01-15T10:30:00Z\",\n \"updated_at\": \"2024-01-15T10:30:00Z\"\n },\n \"relationships\": {\n \"site\": {\n \"data\": {\n \"id\": \"123\",\n \"type\": \"sites\"\n }\n }\n }\n }]\n}\n```\n## Search\nUse the `filter[search]` parameter along with `filter[site_id]` to search contacts.\n\n### Search for contacts containing \"smith\" in site with ID 123\n* `GET /v1/contacts?filter[site_id]=123&filter[search]=smith`\n\nResponse will include matching contacts\n```json\n{\n \"data\": [{\n \"id\": \"456\",\n \"type\": \"contacts\",\n \"attributes\": {\n \"name\": \"John Smith\",\n \"email\": \"smith.john@example.com\",\n \"created_at\": \"2024-01-15T10:30:00Z\",\n \"updated_at\": \"2024-01-15T10:30:00Z\"\n },\n \"relationships\": {\n \"site\": {\n \"data\": {\n \"id\": \"123\",\n \"type\": \"sites\"\n }\n }\n }\n }]\n}\n```\n## Using Pagination with Site Filter\nUse the `filter[site_id]` parameter along with pagination parameters `page[number]` and `page[size]` to get paginated results for a specific site:\n\n### Get page 2 of contacts from site with ID 123, with 10 items per page\n* `GET /v1/contacts?filter[site_id]=123&page[number]=2&page[size]=10`\n\nResponse will include paginated contacts for the specified site along with pagination metadata\n```json\n{\n \"data\": [{\n \"id\": \"456\",\n \"type\": \"contacts\",\n \"attributes\": {\n \"name\": \"John Smith\",\n \"email\": \"smith.john@example.com\",\n \"created_at\": \"2024-01-15T10:30:00Z\",\n \"updated_at\": \"2024-01-15T10:30:00Z\"\n },\n \"relationships\": {\n \"site\": {\n \"data\": {\n \"id\": \"123\",\n \"type\": \"sites\"\n }\n }\n }\n }],\n \"links\": {\n \"self\": \"https://api.kajabi.com/v1/contacts?filter[site_id]=123&page[number]=2&page[size]=10\",\n \"first\": \"https://api.kajabi.com/v1/contacts?filter[site_id]=123&page[number]=1&page[size]=10\",\n \"prev\": \"https://api.kajabi.com/v1/contacts?filter[site_id]=123&page[number]=1&page[size]=10\",\n \"next\": \"https://api.kajabi.com/v1/contacts?filter[site_id]=123&page[number]=3&page[size]=10\",\n \"last\": \"https://api.kajabi.com/v1/contacts?filter[site_id]=123&page[number]=5&page[size]=10\"\n },\n \"meta\": {\n \"total_pages\": 5,\n \"total_count\": 50,\n \"current_page\": 2\n }\n}\n```\n## Using Sort with Site Filter\n* The default Sorting is by created_at in descending order (newest first)\n\nSorting by created_at in ascending order (oldest first)\n* `GET /v1/contacts?filter[site_id]=123&sort=created_at`\n\nUse the `sort` parameter along with `filter[site_id]` to get sorted results for a specific site:\n### Get contacts from site with ID 123, sorted by name in ascending order\n* `GET /v1/contacts?filter[site_id]=123&sort=name`\n### Get contacts from site with ID 123, sorted by email in descending order\n* `GET /v1/contacts?filter[site_id]=123&sort=-email`\n\nResponse will include sorted contacts for the specified site\n```json\n{\n \"data\": [{\n \"id\": \"456\",\n \"type\": \"contacts\",\n \"attributes\": {\n \"name\": \"Alice Smith\",\n \"email\": \"alice@example.com\",\n \"created_at\": \"2024-01-15T10:30:00Z\",\n \"updated_at\": \"2024-01-15T10:30:00Z\"\n },\n \"relationships\": {\n \"site\": {\n \"data\": {\n \"id\": \"123\",\n \"type\": \"sites\"\n }\n }\n }\n }]\n}\n```\n## Using Sparse Fields with Site Filter\nUse the `fields[contacts]` parameter along with `filter[site_id]` to get specific fields for contacts in a site:\n### Get only name and email fields for contacts from site with ID 123\n* `GET /v1/contacts?filter[site_id]=123&fields[contacts]=name,email`\n\nResponse will include only requested fields for contacts in the specified site\n```json\n{\n \"data\": [{\n \"id\": \"456\",\n \"type\": \"contacts\",\n \"attributes\": {\n \"name\": \"Alice Smith\",\n \"email\": \"alice@example.com\"\n },\n \"relationships\": {\n \"site\": {\n \"data\": {\n \"id\": \"123\",\n \"type\": \"sites\"\n }\n }\n }\n }]\n}\n```\n## Filtering by Site and Offer\nUse the `filter[site_id]` parameter along with `filter[has_offer_id]` to get contacts who have been granted a specific offer\n\n### Get contacts from site with ID 123 who have been granted offer with ID 789\n* `GET /v1/contacts?filter[site_id]=123&filter[has_offer_id]=789`\n\nResponse will include only contacts from the specified site who have been granted the offer\n```json\n{\n \"data\": [{\n \"id\": \"456\",\n \"type\": \"contacts\",\n \"attributes\": {\n \"name\": \"Alice Smith\",\n \"email\": \"alice@example.com\",\n \"created_at\": \"2024-01-15T10:30:00Z\",\n \"updated_at\": \"2024-01-15T10:30:00Z\"\n },\n \"relationships\": {\n \"site\": {\n \"data\": {\n \"id\": \"123\",\n \"type\": \"sites\"\n }\n }\n }\n }]\n}\n```\n\n## Filtering by Site and Tag\nUse the `filter[site_id]` parameter along with `filter[has_tag_id]` to get contacts who have a specific tag\n\n### Get contacts from site with ID 123 who have tag with ID 456\n* `GET /v1/contacts?filter[site_id]=123&filter[has_tag_id]=456`\n\nResponse will include only contacts from the specified site who have the tag\n```json\n{\n \"data\": [{\n \"id\": \"789\",\n \"type\": \"contacts\",\n \"attributes\": {\n \"name\": \"Bob Jones\",\n \"email\": \"bob@example.com\",\n \"created_at\": \"2024-01-15T10:30:00Z\",\n \"updated_at\": \"2024-01-15T10:30:00Z\"\n },\n \"relationships\": {\n \"site\": {\n \"data\": {\n \"id\": \"123\",\n \"type\": \"sites\"\n }\n }\n }\n }]\n}\n```\n## Using Multiple Parameters Together\nYou can combine multiple parameters to filter, search, paginate and format the response:\n\n### Get paginated contacts from site 123 with tag 456, searching for \"smith\", using indexed data and sparse fields\n* `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`\n\nResponse will include paginated contacts matching all filters with only requested fields\n```json\n{\n \"data\": [{\n \"id\": \"789\",\n \"type\": \"contacts\",\n \"attributes\": {\n \"name\": \"John Smith\",\n \"email\": \"smith.john@example.com\"\n }\n }],\n \"links\": {\n \"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\",\n \"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\",\n \"prev\": null,\n \"next\": null,\n \"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\"\n },\n \"meta\": {\n \"total_pages\": 1,\n \"total_count\": 1,\n \"current_page\": 1\n }\n}\n```\n", "method": "GET", "path": "/v1/contacts", "tags": [ "Contacts" ], "parameters": [ { "name": "sort", "in": "query", "required": false, "description": "Sort order, use: name, email, created_at, for descending order use '-' e.g. &sort=-name", "schema": { "type": "string" } }, { "name": "page[number]", "in": "query", "required": false, "schema": { "type": "number" } }, { "name": "page[size]", "in": "query", "required": false, "description": "Number of documents", "schema": { "type": "number" } }, { "name": "fields[contacts]", "in": "query", "required": false, "description": "Sparse fields, use: name, email for example ?fields[contacts]=name,email", "schema": { "type": "string" } }, { "name": "filter[site_id]", "in": "query", "required": false, "description": "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", "schema": { "type": "string" } }, { "name": "filter[search]", "in": "query", "required": false, "description": "Filter with fuzzy search of name/email, for example ?filter[search]=alexa", "schema": { "type": "string" } }, { "name": "filter[created_in_last]", "in": "query", "required": false, "description": "Filter contacts created in the last N days, e.g. ?filter[created_in_last]=30", "schema": { "type": "string" } }, { "name": "filter[not_created_in_last]", "in": "query", "required": false, "description": "Filter contacts not created in the last N days", "schema": { "type": "string" } }, { "name": "filter[is_hidden]", "in": "query", "required": false, "description": "Filter hidden contacts", "schema": { "type": "string" } }, { "name": "filter[joined_in_last]", "in": "query", "required": false, "description": "Filter contacts who joined in the last N days", "schema": { "type": "string" } }, { "name": "filter[active_in_last]", "in": "query", "required": false, "description": "Filter contacts active in the last N days", "schema": { "type": "string" } }, { "name": "filter[inactive_in_last]", "in": "query", "required": false, "description": "Filter contacts inactive in the last N days", "schema": { "type": "string" } }, { "name": "filter[name_contains]", "in": "query", "required": false, "description": "Filter contacts whose name contains the given value", "schema": { "type": "string" } }, { "name": "filter[email_contains]", "in": "query", "required": false, "description": "Filter contacts whose email contains the given value", "schema": { "type": "string" } }, { "name": "filter[phone_number_contains]", "in": "query", "required": false, "description": "Filter contacts whose phone number contains the given value", "schema": { "type": "string" } }, { "name": "filter[address_line_1_contains]", "in": "query", "required": false, "description": "Filter contacts whose address line 1 contains the given value", "schema": { "type": "string" } }, { "name": "filter[address_line_2_contains]", "in": "query", "required": false, "description": "Filter contacts whose address line 2 contains the given value", "schema": { "type": "string" } }, { "name": "filter[address_city_contains]", "in": "query", "required": false, "description": "Filter contacts whose city contains the given value", "schema": { "type": "string" } }, { "name": "filter[address_state_contains]", "in": "query", "required": false, "description": "Filter contacts whose state contains the given value", "schema": { "type": "string" } }, { "name": "filter[address_country_contains]", "in": "query", "required": false, "description": "Filter contacts whose country contains the given value", "schema": { "type": "string" } }, { "name": "filter[address_zip_contains]", "in": "query", "required": false, "description": "Filter contacts whose zip code contains the given value", "schema": { "type": "string" } }, { "name": "filter[has_tag_id]", "in": "query", "required": false, "description": "Filter contacts with a specific tag ID", "schema": { "type": "string" } }, { "name": "filter[has_all_tag_id]", "in": "query", "required": false, "description": "Filter contacts with all specified tag IDs", "schema": { "type": "string" } }, { "name": "filter[has_no_tag_id]", "in": "query", "required": false, "description": "Filter contacts without the specified tag ID", "schema": { "type": "string" } }, { "name": "filter[subscribed]", "in": "query", "required": false, "description": "Filter subscribed contacts", "schema": { "type": "string" } }, { "name": "filter[has_offer_id]", "in": "query", "required": false, "description": "Filter contacts with a specific offer ID", "schema": { "type": "string" } }, { "name": "filter[has_no_offer_id]", "in": "query", "required": false, "description": "Filter contacts without the specified offer ID", "schema": { "type": "string" } }, { "name": "filter[has_product_id]", "in": "query", "required": false, "description": "Filter contacts who own a specific product ID", "schema": { "type": "string" } }, { "name": "filter[has_active_product_id]", "in": "query", "required": false, "description": "Filter contacts with an active membership to a specific product ID", "schema": { "type": "string" } }, { "name": "filter[has_no_product_id]", "in": "query", "required": false, "description": "Filter contacts who do not own a specific product ID", "schema": { "type": "string" } }, { "name": "filter[previously_owned_product_id]", "in": "query", "required": false, "description": "Filter contacts who previously owned a specific product ID", "schema": { "type": "string" } }, { "name": "filter[used_coupon_code]", "in": "query", "required": false, "description": "Filter contacts who used a specific coupon code", "schema": { "type": "string" } }, { "name": "filter[submitted_form_id]", "in": "query", "required": false, "description": "Filter contacts who submitted a specific form ID", "schema": { "type": "string" } }, { "name": "filter[no_submitted_form_id]", "in": "query", "required": false, "description": "Filter contacts who have not submitted the specified form ID", "schema": { "type": "string" } }, { "name": "filter[registered_event_id]", "in": "query", "required": false, "description": "Filter contacts who registered for a specific event ID", "schema": { "type": "string" } }, { "name": "filter[not_registered_event_id]", "in": "query", "required": false, "description": "Filter contacts who have not registered for the specified event ID", "schema": { "type": "string" } }, { "name": "filter[completed_assessment_id]", "in": "query", "required": false, "description": "Filter contacts who completed a specific assessment ID", "schema": { "type": "string" } }, { "name": "filter[passed_assessment_id]", "in": "query", "required": false, "description": "Filter contacts who passed a specific assessment ID", "schema": { "type": "string" } }, { "name": "filter[failed_assessment_id]", "in": "query", "required": false, "description": "Filter contacts who failed a specific assessment ID", "schema": { "type": "string" } }, { "name": "filter[net_revenue_equal_to]", "in": "query", "required": false, "description": "Filter contacts whose net revenue equals the given value", "schema": { "type": "string" } }, { "name": "filter[net_revenue_greater_than]", "in": "query", "required": false, "description": "Filter contacts whose net revenue is greater than the given value", "schema": { "type": "string" } }, { "name": "filter[net_revenue_less_than]", "in": "query", "required": false, "description": "Filter contacts whose net revenue is less than the given value", "schema": { "type": "string" } }, { "name": "filter[subscribed_in_last]", "in": "query", "required": false, "description": "Filter contacts subscribed in the last N days", "schema": { "type": "string" } }, { "name": "filter[unsubscribed_in_last]", "in": "query", "required": false, "description": "Filter contacts unsubscribed in the last N days", "schema": { "type": "string" } }, { "name": "filter[never_subscribed]", "in": "query", "required": false, "description": "Filter contacts who have never subscribed", "schema": { "type": "string" } }, { "name": "filter[sent_email_broadcast_id]", "in": "query", "required": false, "description": "Filter contacts who were sent a specific email broadcast ID", "schema": { "type": "string" } }, { "name": "filter[no_sent_email_broadcast_id]", "in": "query", "required": false, "description": "Filter contacts who were not sent the specified email broadcast ID", "schema": { "type": "string" } }, { "name": "filter[no_sent_email_broadcast_ids]", "in": "query", "required": false, "description": "Filter contacts who were not sent any of the specified email broadcast IDs", "schema": { "type": "string" } }, { "name": "filter[no_delivered_email_broadcast_id]", "in": "query", "required": false, "description": "Filter contacts who did not receive the specified email broadcast ID", "schema": { "type": "string" } }, { "name": "filter[opened_email_broadcast_id]", "in": "query", "required": false, "description": "Filter contacts who opened a specific email broadcast ID", "schema": { "type": "string" } }, { "name": "filter[no_opened_email_broadcast_id]", "in": "query", "required": false, "description": "Filter contacts who did not open the specified email broadcast ID", "schema": { "type": "string" } }, { "name": "filter[clicked_email_broadcast_id]", "in": "query", "required": false, "description": "Filter contacts who clicked a specific email broadcast ID", "schema": { "type": "string" } }, { "name": "filter[no_clicked_email_broadcast_id]", "in": "query", "required": false, "description": "Filter contacts who did not click the specified email broadcast ID", "schema": { "type": "string" } }, { "name": "filter[bounced_email_broadcast_id]", "in": "query", "required": false, "description": "Filter contacts who bounced a specific email broadcast ID", "schema": { "type": "string" } }, { "name": "filter[no_bounced_email_broadcast_id]", "in": "query", "required": false, "description": "Filter contacts who did not bounce the specified email broadcast ID", "schema": { "type": "string" } }, { "name": "filter[dropped_email_broadcast_id]", "in": "query", "required": false, "description": "Filter contacts who dropped a specific email broadcast ID", "schema": { "type": "string" } }, { "name": "filter[no_dropped_email_broadcast_id]", "in": "query", "required": false, "description": "Filter contacts who did not drop the specified email broadcast ID", "schema": { "type": "string" } }, { "name": "filter[opened_email_in_last]", "in": "query", "required": false, "description": "Filter contacts who opened an email in the last N days", "schema": { "type": "string" } }, { "name": "filter[not_opened_email_in_last]", "in": "query", "required": false, "description": "Filter contacts who did not open an email in the last N days", "schema": { "type": "string" } }, { "name": "filter[delivered_email_in_last]", "in": "query", "required": false, "description": "Filter contacts who were delivered an email in the last N days", "schema": { "type": "string" } }, { "name": "filter[not_delivered_email_in_last]", "in": "query", "required": false, "description": "Filter contacts who were not delivered an email in the last N days", "schema": { "type": "string" } }, { "name": "filter[clicked_email_in_last]", "in": "query", "required": false, "description": "Filter contacts who clicked an email in the last N days", "schema": { "type": "string" } }, { "name": "filter[not_clicked_email_in_last]", "in": "query", "required": false, "description": "Filter contacts who did not click an email in the last N days", "schema": { "type": "string" } }, { "name": "filter[is_hard_bouncing]", "in": "query", "required": false, "description": "Filter contacts that are hard bouncing", "schema": { "type": "string" } }, { "name": "filter[bounced_in_last]", "in": "query", "required": false, "description": "Filter contacts who bounced in the last N days", "schema": { "type": "string" } }, { "name": "filter[complained_in_last]", "in": "query", "required": false, "description": "Filter contacts who complained in the last N days", "schema": { "type": "string" } }, { "name": "filter[manually_unsubscribed_in_last]", "in": "query", "required": false, "description": "Filter contacts manually unsubscribed in the last N days", "schema": { "type": "string" } }, { "name": "filter[opted_out_in_last]", "in": "query", "required": false, "description": "Filter contacts who opted out in the last N days", "schema": { "type": "string" } }, { "name": "filter[healthy_contacts_with_open_data]", "in": "query", "required": false, "description": "Filter healthy contacts with open data", "schema": { "type": "string" } }, { "name": "filter[passive_contacts_with_open_data]", "in": "query", "required": false, "description": "Filter passive contacts with open data", "schema": { "type": "string" } }, { "name": "filter[unengaged_contacts_with_open_data]", "in": "query", "required": false, "description": "Filter unengaged contacts with open data", "schema": { "type": "string" } }, { "name": "filter[inactive_contacts_with_open_data]", "in": "query", "required": false, "description": "Filter inactive contacts with open data", "schema": { "type": "string" } }, { "name": "filter[subscribed_newsletter_id]", "in": "query", "required": false, "description": "Filter contacts subscribed to a specific newsletter ID", "schema": { "type": "string" } }, { "name": "filter[unsubscribed_newsletter_id]", "in": "query", "required": false, "description": "Filter contacts unsubscribed from a specific newsletter ID", "schema": { "type": "string" } }, { "name": "filter[mobile_phone_number_contains]", "in": "query", "required": false, "description": "Filter contacts whose mobile phone number contains the given value", "schema": { "type": "string" } }, { "name": "filter[subscribed_email_sequence_id]", "in": "query", "required": false, "description": "Filter contacts subscribed to a specific email sequence ID", "schema": { "type": "string" } }, { "name": "filter[not_subscribed_email_sequence_id]", "in": "query", "required": false, "description": "Filter contacts not subscribed to a specific email sequence ID", "schema": { "type": "string" } } ], "requestBody": null, "responses": { "200": { "description": "Success, list search results", "content_type": "application/json" } } }