Keap
App · 20 actions
Manage contacts, companies, tasks and tags with Keap API v2.
Actions
| Action | What it does |
|---|---|
| Create company | Create a Company. |
| Create contact | Create a Contact. |
| Create tag | Create Tag. |
| Create task | Create a Task. |
| Delete company | Delete a Company. |
| Delete contact | Delete a Contact. |
| Delete tag | Delete Tag. |
| Delete task | Delete a Task. |
| Get company | Retrieve a Company. |
| Get contact | Retrieve a Contact. |
| Get tag | Retrieve a Tag. |
| Get task | Retrieve a Task. |
| List companies | List Companies. |
| List contacts | List Contacts. |
| List tags | List Tags. |
| List tasks | List Tasks. |
| Update company | Update a Company. |
| Update contact | Update a Contact. |
| Update tag | Update a Tag. |
| Update task | Update a Task. |
Create company
Create a Company.
Inputs
- Address
addressobject - Address.
- Notes
notestext - Notes about the company
- Website
websitetext - The company's website URL
- Suffix
suffixtext - Name suffix
- Title
titletext - Name prefix or salutation
- Company name
company_nametextRequired - The name of the company
- Custom fields
custom_fieldslist - Custom fields.
- Email address
email_addressobject - Email address.
- Fax number
fax_numberobject - Fax number.
- Phone number
phone_numberobject - Phone number.
- Anniversary date
anniversary_datetext - The anniversary date
- Assistant name
assistant_nametext - The name of the company contact's assistant
- Assistant phone
assistant_phonetext - The phone number of the company contact's assistant
- Billing information
billing_informationtext - Billing information for the company
- Birth date
birth_datetext - The birth date
- Contact type
contact_typetext - Type of contact
- First name
first_nametext - First name of the company contact
- Job title
job_titletext - Job title of the company contact
- Last name
last_nametext - Last name of the company contact
- Middle name
middle_nametext - Middle name of the company contact
- Preferred name
preferred_nametext - Preferred name or nickname of the company contact
- Owner ID
owner_idtext - ID of the user who owns this company
- Referral code
referral_codetext - Referral code
- Spouse name
spouse_nametext - Spouse's name
Outputs
dataobject- Keap response data.
Example output
{
"data": {
"account_id": "example",
"address": {
"country": "example",
"country_code": "example",
"field": "ADDRESS_FIELD_UNSPECIFIED",
"line1": "example",
"line2": "example",
"locality": "example",
"postal_code": "example",
"region": "example",
"region_code": "example",
"zip_code": "example",
"zip_four": "example"
},
"anniversary_date": "example",
"assistant_name": "example",
"assistant_phone": "example",
"billing_information": "example",
"birth_date": "example",
"company_name": "example",
"contact_type": "example",
"create_time": "example",
"created_by": "example",
"custom_fields": [],
"email_address": {
"email": "example",
"email_opt_status": "UNENGAGED_MARKETABLE",
"field": "EMAIL_FIELD_UNSPECIFIED",
"is_opt_in": false,
"opt_in_reason": "example"
},
"fax_number": {
"field": "FAX_NUMBER_FIELD_UNSPECIFIED",
"number": "example",
"type": "example"
},
"first_name": "example",
"groups": "example",
"id": "example",
"job_title": "example",
"last_name": "example",
"last_updated_by": "example",
"middle_name": "example",
"notes": "example",
"owner_id": "example",
"phone_number": {
"extension": "example",
"field": "PHONE_NUMBER_FIELD_UNSPECIFIED",
"number": "example",
"number_e164": "example",
"type": "example"
},
"preferred_name": "example",
"referral_code": "example",
"spouse_name": "example",
"suffix": "example",
"title": "example",
"update_time": "example",
"website": "example"
}
}Create contact
Create a Contact.
Inputs
- Fields
fieldslist - Comma-delimited list of Contact properties to include in the response. (Available fields are: addresses,anniversary_date,birth_date,company,contact_type,create_time, custom_fields,email_addresses,family_name,fax_numbers,given_name,id,job_title,leadsource_id, links,middle_name,notes,origin,owner_id,phone_numbers,preferred_locale,preferred_name,prefix, referral_code,score_value,social_accounts,source_type,spouse_name,suffix,tag_ids,time_zone, update_time,utm_parameters,website,account_id,assistant_name,assistant_phone, billing_information,created_by,groups,last_updated_by)One or more of:
id,links,addresses,company,origin,prefix,suffix,website,groups,update_time(Update time), and 30 more. - Duplicate option
duplicate_optiontext - Duplicate check strategy. If provided, performs duplicate checking and updates the existing contact if a match is found.One of:
Email,EmailAndName,EmailAndNameAndCompany. - Addresses
addresseslist - Any item not listed here will be removed if it already exists. If an empty array is specified, all existing values will be removed.
- Company
companyobject - Company.
- Origin
originobject - Origin.
- Prefix
prefixtext - Name prefix
- Suffix
suffixtext - Name suffix
- Website
websitetext - Personal website URL
- Anniversary date
anniversary_datetext - The anniversary date
- Birth date
birth_datetext - The birth date
- Contact type
contact_typetext - Type of contact
- Custom fields
custom_fieldslist - Any item not listed here will be removed if it already exists. If an empty array is specified, all existing values will be removed.
- Email addresses
email_addresseslist - Any item not listed here will be removed if it already exists. If an empty array is specified, all existing values will be removed.
- Family name
family_nametext - Last name / surname
- Fax numbers
fax_numberslist - Any item not listed here will be removed if it already exists. If an empty array is specified, all existing values will be removed.
- Given name
given_nametextRequired - First name
- Job title
job_titletext - Job title
- Leadsource ID
leadsource_idtext - Lead source identifier
- Middle name
middle_nametext - Middle name
- Owner ID
owner_idtext - ID of the user who owns this contact
- Phone numbers
phone_numberslist - Any item not listed here will be removed if it already exists. If an empty array is specified, all existing values will be removed.
- Preferred locale
preferred_localetext - Preferred locale
- Preferred name
preferred_nametext - Preferred name or nickname
- Referral code
referral_codetext - Referral code
- Social accounts
social_accountslist - Any item not listed here will be removed if it already exists. If an empty array is specified, all existing values will be removed.
- Source type
source_typetext - Source type.One of:
SOURCE_TYPE_UNSPECIFIED(Source type unspecified),API,APPOINTMENT,FORM_API_HOSTED(Form api hosted),FORM_API_INTERNAL(Form api internal),IMPORT,INTERNAL_FORM(Internal form),LANDING_PAGE(Landing page),MANUAL,OTHER,UNKNOWN,WEBFORM. - Spouse name
spouse_nametext - Spouse's name
- Time zone
time_zonetext - Contact's timezone
- Utm parameters
utm_parametersobject - Utm parameters.
- Assistant name
assistant_nametext - Assistant's name
- Assistant phone
assistant_phonetext - Assistant's phone number
- Billing information
billing_informationtext - Billing information
Outputs
dataobject- Keap response data.
Example output
{
"data": {
"account_id": "example",
"addresses": [],
"anniversary_date": "example",
"assistant_name": "example",
"assistant_phone": "example",
"billing_information": "example",
"birth_date": "example",
"company": {
"company_name": "example",
"id": "example"
},
"contact_type": "example",
"create_time": "example",
"created_by": "example",
"custom_fields": [],
"email_addresses": [],
"family_name": "example",
"fax_numbers": [],
"given_name": "example",
"groups": "example",
"id": "example",
"job_title": "example",
"last_updated_by": "example",
"leadsource_id": "example",
"links": [],
"middle_name": "example",
"origin": {
"date": "example",
"ip_address": "example"
},
"owner_id": "example",
"phone_numbers": [],
"preferred_locale": "example",
"preferred_name": "example",
"prefix": "example",
"referral_code": "example",
"score_value": "example",
"social_accounts": [],
"source_type": "SOURCE_TYPE_UNSPECIFIED",
"spouse_name": "example",
"suffix": "example",
"tag_ids": [],
"time_zone": "example",
"update_time": "example",
"utm_parameters": [],
"website": "example"
}
}Create tag
Create Tag.
Inputs
- Name
nametextRequired - Name of the tag, up to 255 characters will be saved
- Description
descriptiontext - Description of the tag
- Category
categoryobject - Category.
Outputs
dataobject- Keap response data.
Example output
{
"data": {
"category": {
"id": "example"
},
"create_time": "example",
"description": "example",
"id": "example",
"name": "example",
"update_time": "example"
}
}Create task
Create a Task.
Inputs
- Fields
fieldslist - Comma-delimited list of optional Task properties to include in the response. Allowed values: custom_fieldsOne or more of:
id,title,description,type,priority,completed,create_time(Create time),modification_time(Modification time),completion_time(Completion time),due_time(Due time), and 8 more. - Title
titletextRequired - Task title
- Description
descriptiontext - Task description
- Type
typetext - Task type
- Priority
prioritytext - Task priorityOne of:
CRITICAL,ESSENTIAL,NONESSENTIAL. - Completed
completedtrue/false - Whether task is completed
- Completion time
completion_timetext - Completion timestamp (ISO-8601)
- Due time
due_timetext - Due date/time (ISO-8601)
- Remind time mins
remind_time_minsnumber - Value in minutes before start_date to show pop-up reminder.One of:
5,10,15,30,60,120,240,480,1440,2880. - Assigned to user ID
assigned_to_user_idtextRequired - Assigned user ID
- Contact
contact_idtext - Associated contact ID
- Opportunity ID
opportunity_idtext - Associated opportunity ID
- Accepted
acceptedtrue/false - Whether the task has been accepted.
- Custom fields
custom_fieldslist - Custom field values for the task. An empty array resets all custom fields to their defaults.
Outputs
dataobject- Keap response data.
Example output
{
"data": {
"accepted": false,
"assigned_to_user_id": "example",
"completed": false,
"completion_time": "example",
"contact_id": "example",
"create_time": "example",
"created_by_user_id": "example",
"custom_fields": [],
"description": "example",
"due_time": "example",
"id": "example",
"last_updated_by_user_id": "example",
"modification_time": "example",
"opportunity_id": "example",
"priority": "CRITICAL",
"remind_time_mins": 5,
"title": "example",
"type": "example"
}
}Delete company
Delete a Company.
Inputs
- Company
company_idtextRequired - company_id
Outputs
dataobject- Keap response data.
Example output
{
"data": {}
}Delete contact
Delete a Contact.
Inputs
- Contact
contact_idtextRequired - contact_id
Outputs
dataobject- Keap response data.
Example output
{
"data": {}
}Delete tag
Delete Tag.
Inputs
- Tag
tag_idtextRequired - tag_id
Outputs
dataobject- Keap response data.
Example output
{
"data": {}
}Delete task
Delete a Task.
Inputs
- Task
task_idtextRequired - task_id
Outputs
dataobject- Keap response data.
Example output
{
"data": {}
}Get company
Retrieve a Company.
Inputs
- Company
company_idtextRequired - company_id
- Fields
fieldslist - Comma-delimited list of Company properties to include in the response. (Available fields are: `address`, `custom_fields`, `email_address`, `fax_number`, `phone_number`, `website`, `notes`)One or more of:
id,address,notes,website,suffix,title,groups,company_name(Company name),custom_fields(Custom fields),email_address(Email address), and 21 more.
Outputs
dataobject- Keap response data.
Example output
{
"data": {
"account_id": "example",
"address": {
"country": "example",
"country_code": "example",
"field": "ADDRESS_FIELD_UNSPECIFIED",
"line1": "example",
"line2": "example",
"locality": "example",
"postal_code": "example",
"region": "example",
"region_code": "example",
"zip_code": "example",
"zip_four": "example"
},
"anniversary_date": "example",
"assistant_name": "example",
"assistant_phone": "example",
"billing_information": "example",
"birth_date": "example",
"company_name": "example",
"contact_type": "example",
"create_time": "example",
"created_by": "example",
"custom_fields": [],
"email_address": {
"email": "example",
"email_opt_status": "UNENGAGED_MARKETABLE",
"field": "EMAIL_FIELD_UNSPECIFIED",
"is_opt_in": false,
"opt_in_reason": "example"
},
"fax_number": {
"field": "FAX_NUMBER_FIELD_UNSPECIFIED",
"number": "example",
"type": "example"
},
"first_name": "example",
"groups": "example",
"id": "example",
"job_title": "example",
"last_name": "example",
"last_updated_by": "example",
"middle_name": "example",
"notes": "example",
"owner_id": "example",
"phone_number": {
"extension": "example",
"field": "PHONE_NUMBER_FIELD_UNSPECIFIED",
"number": "example",
"number_e164": "example",
"type": "example"
},
"preferred_name": "example",
"referral_code": "example",
"spouse_name": "example",
"suffix": "example",
"title": "example",
"update_time": "example",
"website": "example"
}
}Get contact
Retrieve a Contact.
Inputs
- Contact
contact_idtextRequired - contact_id
- Fields
fieldslist - Comma-delimited list of Contact properties to include in the response. (Available fields are: addresses,anniversary_date,birth_date,company,contact_type,create_time, custom_fields,email_addresses,family_name,fax_numbers,given_name,id,job_title,leadsource_id, links,middle_name,notes,origin,owner_id,phone_numbers,preferred_locale,preferred_name,prefix, referral_code,score_value,social_accounts,source_type,spouse_name,suffix,tag_ids,time_zone, update_time,utm_parameters,website,account_id,assistant_name,assistant_phone, billing_information,created_by,groups,last_updated_by)One or more of:
id,links,addresses,company,origin,prefix,suffix,website,groups,update_time(Update time), and 30 more.
Outputs
dataobject- Keap response data.
Example output
{
"data": {
"account_id": "example",
"addresses": [],
"anniversary_date": "example",
"assistant_name": "example",
"assistant_phone": "example",
"billing_information": "example",
"birth_date": "example",
"company": {
"company_name": "example",
"id": "example"
},
"contact_type": "example",
"create_time": "example",
"created_by": "example",
"custom_fields": [],
"email_addresses": [],
"family_name": "example",
"fax_numbers": [],
"given_name": "example",
"groups": "example",
"id": "example",
"job_title": "example",
"last_updated_by": "example",
"leadsource_id": "example",
"links": [],
"middle_name": "example",
"origin": {
"date": "example",
"ip_address": "example"
},
"owner_id": "example",
"phone_numbers": [],
"preferred_locale": "example",
"preferred_name": "example",
"prefix": "example",
"referral_code": "example",
"score_value": "example",
"social_accounts": [],
"source_type": "SOURCE_TYPE_UNSPECIFIED",
"spouse_name": "example",
"suffix": "example",
"tag_ids": [],
"time_zone": "example",
"update_time": "example",
"utm_parameters": [],
"website": "example"
}
}Get tag
Retrieve a Tag.
Inputs
- Tag
tag_idtextRequired - tag_id
Outputs
dataobject- Keap response data.
Example output
{
"data": {
"category": {
"id": "example"
},
"create_time": "example",
"description": "example",
"id": "example",
"name": "example",
"update_time": "example"
}
}Get task
Retrieve a Task.
Inputs
- Task
task_idtextRequired - task_id
- Fields
fieldslist - Comma-delimited list of optional Task properties to include in the response. Allowed values: custom_fieldsOne or more of:
id,title,description,type,priority,completed,create_time(Create time),modification_time(Modification time),completion_time(Completion time),due_time(Due time), and 8 more.
Outputs
dataobject- Keap response data.
Example output
{
"data": {
"accepted": false,
"assigned_to_user_id": "example",
"completed": false,
"completion_time": "example",
"contact_id": "example",
"create_time": "example",
"created_by_user_id": "example",
"custom_fields": [],
"description": "example",
"due_time": "example",
"id": "example",
"last_updated_by_user_id": "example",
"modification_time": "example",
"opportunity_id": "example",
"priority": "CRITICAL",
"remind_time_mins": 5,
"title": "example",
"type": "example"
}
}List companies
List Companies.
Inputs
- Fields
fieldslist - Comma-delimited list of Company properties to include in the response. (Fields such as `notes`, `fax_number`, `address`, `email_address`, `phone_number`, `update_time`, `create_time` and `custom_fields` aren't included, by default.)One or more of:
id,address,notes,website,suffix,title,groups,company_name(Company name),custom_fields(Custom fields),email_address(Email address), and 21 more. - Filter
filtertext - Filter to apply, allowed fields are: - (String) `company_name` - exact match on company name (equality only) - (String) `name` - company name with support for a wildcard at the end (e.g. `smith*`) - (String) `email` - exact match on email - (String) `city` - company city (Contact.City) with support for a prefix wildcard at the end (e.g. `Chan*`) - (String) `state` - company state/region (Contact.State) with support for a prefix wildcard at the end (e.g. `Ar*`) - (String) `since_time` - companies updated on or after this time - (String) `until_time` - companies updated on or before this time - (Number) `company_id` - supports comparison operators: `==`, `>`, `<`, `>=`, `<=` For equality filters, use the `==` operator in encoded form `%3D%3D`: - `filter=company_name%3D%3DCompany` - `filter=email%3D%3Dtest@gmail.com` - `filter=city%3D%3DChandler` - `filter=since_time%3D%3D2025-04-16T20:33:02.321Z` - `filter=until_time%3D%3D2025-08-16T20:33:02.321Z` For wildcard name/city/state search (prefix only, case-insensitive): - `filter=name%3D%3DAcme%2A` (starts with "Acme") - `filter=city%3D%3DChan%2A` (city starts with "Chan") - `filter=city%3D%3DChandler%3Bstate%3D%3DArizona` (combined city + state filter) For company_id comparison: - `filter=company_id%3E5` (company_id > 5) - `filter=company_id%3E%3D10` (company_id >= 10) Custom fields can be filtered by their field name (case-insensitive). A standard field above takes precedence over a custom field with the same name. The supported operators depend on the custom field's type: - Text-like fields (text, text area, name, email, phone, website, social security number) and single-value choice fields with text options (dropdown, radio, state): `==` only, with optional trailing wildcard (e.g. `Industry%3D%3DTech%2A`) - Yes/No and drilldown fields: `==` only - Numeric fields (whole number, decimal, currency, percent, year, month, day of week, user): `==`, `>`, `<`, `>=`, `<=` - Date fields: `==`, `>`, `<`, `>=`, `<=` using full ISO 8601 (same as `since_time`/`until_time`) - Multi-select fields: `==` matches records that contain the given option Examples (for a custom field named `Height`): - `filter=Height%3D%3DTall` - `filter=Height%3E100` Custom field filtering on non-indexed fields is supported but may be slower.
- Order by
order_bytext - Attribute and direction to order items. One of the following fields: - `id` - `create_time` - `name` - `email` One of the following directions: - `asc` - `desc`
- Page size
page_sizenumber - Total number of items to return per pageFrom 0 to 1000.
- Page token
page_tokentext - Page token
Outputs
dataobject- Keap response data.
Example output
{
"data": {
"companies": [],
"next_page_token": "example"
}
}List contacts
List Contacts.
Inputs
- Fields
fieldslist - Comma-delimited list of Contact properties to include in the response. (Available fields are: addresses,anniversary_date,birth_date,company,contact_type,create_time, custom_fields,email_addresses,family_name,fax_numbers,given_name,id,job_title,leadsource_id, links,middle_name,notes,origin,owner_id,phone_numbers,preferred_locale,preferred_name,prefix, referral_code,score_value,social_accounts,source_type,spouse_name,suffix,tag_ids,time_zone, update_time,utm_parameters,website,account_id,assistant_name,assistant_phone, billing_information,created_by,groups,last_updated_by)One or more of:
id,links,addresses,company,origin,prefix,suffix,website,groups,update_time(Update time), and 30 more. - Filter
filtertext - Filter to apply, allowed fields are: - (String) `email`: supports wildcard (e.g. `email==john*`) - (String) `given_name`: supports wildcard (e.g. `given_name==Mar*`) - (String) `family_name`: supports wildcard (e.g. `family_name==Smi*`) - (String) `middle_name`: supports wildcard (e.g. `middle_name==J*`) - (String) `company_id` - (Set[String]) `contact_ids` - (Set[String]) `ids`: accepts a list of contact IDs (e.g. `ids==1,2,3`) - (String) `start_update_time` - (String) `end_update_time` - (String) `phone_number`: the phone number to search for; supports prefix wildcard (e.g. `phone_number==555*`, "starts with"). Wildcard prefix must be at least 3 characters (e.g. `phone_number==55*` is rejected). Requires `phone_fields` to be specified; only the specified phone fields are searched. - (Set[String]) `phone_fields`: restricts which phone fields to search (e.g. PHONE1, PHONE2, or comma-separated list PHONE1,PHONE2,PHONE3,PHONE4,PHONE5). Required when `phone_number` is supplied. - (String) `billing_address_line1` - (String) `billing_address_locality` - (String) `billing_address_region` (long-form region/state name, e.g. "Arizona") - (String) `billing_address_postal_code` - (String) `billing_address_country_code` (ISO 3166-1 alpha-3, e.g. "USA") - (String) `shipping_address_line1` - (String) `shipping_address_locality` - (String) `shipping_address_region` - (String) `shipping_address_postal_code` - (String) `shipping_address_country_code` - (String) `other_address_line1` - (String) `other_address_locality` - (String) `other_address_region` - (String) `other_address_postal_code` - (String) `other_address_country_code` - (String) `city`: primary-address city (Contact.City); supports prefix wildcard (e.g. `city==Chan*`, "starts with") - (String) `state`: primary-address state/region (Contact.State); supports prefix wildcard (e.g. `state==Ar*`, "starts with") - (String) `website`: supports wildcard (e.g. `website==https://example*`) - (String) `lead_source_name`: supports wildcard (e.g. `lead_source_name==Google*`) - (String) `contact_id`: supports comparison operators: `==`, `>`, `<`, `>=`, `<=` (e.g. `contact_id>5` encoded as `contact_id%3E5`) Custom fields can be filtered by their field_name (case-insensitive, as returned by GET /v2/contacts/model). A standard field above takes precedence over a custom field with the same name. The supported operators depend on the custom field's type: - Text-like fields (text, text area, name, email, phone, website, social security number) and single-value choice fields with text options (dropdown, radio, state): `==` only, with optional trailing wildcard (e.g. `firstName1%3D%3DValue%2A`) - Yes/No and drilldown fields: `==` only - Numeric fields (whole number, decimal, currency, percent, year, month, day of week, user): `==`, `>`, `<`, `>=`, `<=` - Date fields: `==`, `>`, `<`, `>=`, `<=`; the value must be a full ISO-8601 date-time with milliseconds and a timezone offset (e.g. `2026-01-01T00:00:00.000Z`), the same format as `start_update_time`/`end_update_time`. Date-only values such as `2026-01-01` are rejected - Multi-select fields: `==` matches records that contain the given option Custom field filtering on non-indexed fields is supported but may be slower. You will need to apply the `==` operator to check the equality of one of the filters with your searched word, in the encoded form `%3D%3D`. For wildcard filtering, use `*` at the end of the value (prefix matching), encoded as `%2A`. For the filters listed above, here are some examples: - `filter=given_name%3D%3DMary` - `filter=given_name%3D%3DMar%2A` (wildcard: starts with "Mar") - `filter=company_id%3D%3D123` - `filter=company_id%3D%3D123%3Bfamily_name%3D%3DSmith` - `filter=billing_address_locality%3D%3DChandler` - `filter=city%3D%3DChandler` (city exact match) - `filter=city%3D%3DChan%2A` (city prefix wildcard: starts with "Chan") - `filter=city%3D%3DChandler%3Bstate%3D%3DArizona` (combined city + state filter) - `filter=shipping_address_country_code%3D%3DUSA%3Bshipping_address_region%3D%3DArizona` - `filter=contact_id%3E5` (contact_id > 5) - `filter=ids%3D%3D1,2,3` (contacts with IDs 1, 2, or 3) Custom field examples (for custom fields with field_name `firstName1` and `Score0`): - `filter=firstName1%3D%3DJohn` (custom field exact match) - `filter=firstName1%3D%3DJo%2A` (custom field prefix wildcard) - `filter=Score0%3E100` (custom field numeric comparison) - `filter=given_name%3D%3DJohn%3BStatus0%3D%3DActive` (combined standard + custom field filter)
- Order by
order_bytext - Attribute and direction to order items. One of the following fields: - `id` - `create_time` - `email` - `update_time` One of the following directions: - `asc` - `desc`
- Page size
page_sizenumber - Total number of items to return per pageFrom 0 to 1000.
- Page token
page_tokentext - Page token
Outputs
dataobject- Keap response data.
Example output
{
"data": {
"contacts": [],
"next_page_token": "example"
}
}List tags
List Tags.
Inputs
- Filter
filtertext - Filter to apply, allowed fields are: - (String) `name` - (String) `description` - (String) `category_id` - (String) `tag_ids` - (String) `since_create_time` - (String) `until_create_time` - (String) `since_update_time` - (String) `until_update_time` You will need to apply the `==` operator to check the equality of one of the filters with your searched word, in the encoded form `%3D%3D`. If NONE is passed in for `category_id` or `description`, it will check for the non-existence of that field. For the filters listed above, here are some examples: - `filter=name%3D%3Dmy-tag` - `filter=category_id%3D%3DNONE` - `filter=description%3D%3DNONE` - `filter=tag_ids%3D%3D1,2,3` - `filter=since_create_time%3D%3D2024-12-22T01:00:00.000Z;until_create_time%3D%3D2025-01-01T00:00:00.000Z;`
- Order by
order_bytext - Attribute and direction to order items. One of the following fields: - `name` - `create_time` - `update_time` One of the following directions: - `asc` - `desc`
- Page size
page_sizenumber - Total number of items to return per pageFrom 0 to 1000.
- Page token
page_tokentext - Page token
Outputs
dataobject- Keap response data.
Example output
{
"data": {
"next_page_token": "example",
"tags": []
}
}List tasks
List Tasks.
Inputs
- Filter
filtertext - Filter to apply, allowed fields are: - (String) `contact_id` - (String) `has_due_date` - (String) `is_completed` - (String) `user_id` - (String) `opportunity_id` - (String) `task_ids` - (String) `priority` : one of `CRITICAL`, `ESSENTIAL`, `NONESSENTIAL` - (String) `since_time` - (String) `until_time` - (String) `id` : supports `==`, `>`, `<`, `>=`, `<=` - (String) `title` : supports prefix wildcard (`title==Foo*`) Operators must be URL-encoded (`==` → `%3D%3D`, `>` → `%3E`, `<` → `%3C`). For the filters listed above, here are some examples: - `filter=contact_id%3D%3D123` - `filter=has_due_date%3D%3Dtrue` - `filter=is_completed%3D%3Dtrue` - `filter=user_id%3D%3D321` - `filter=opportunity_id%3D%3D321` - `filter=task_ids%3D%3D1,2,3` - `filter=priority%3D%3DCRITICAL` - `filter=since_time%3D%3D2025-04-16T20:33:02.321Z;` - `filter=until_time%3D%3D2025-08-16T20:33:02.321Z;` - `filter=id%3E5` (id > 5) - `filter=id%3C%3D100` (id <= 100) - `filter=title%3D%3DFollow%2A` (title starts with "Follow") **Custom fields:** tasks may also be filtered by any custom field defined on the Task record, referenced by its field name (e.g. `filter=cf_priority%3D%3D10`). Both indexed and non-indexed custom fields are filterable. Operators must be URL-encoded, same as the standard fields above. The supported operator and value depend on the field's data type: - Text-like fields (Text, Text Area, Name, Email, Website, Phone, Social Security Number) and choice fields with text options (Dropdown, Radio, State): equals (`==`) and prefix wildcard (e.g. `cf_company%3D%3DAcme%2A`) - Numeric fields (Whole Number, Decimal, Currency, Percent, Year, Month, Day of Week, User): equals and comparison (`==`, `>`, `<`, `>=`, `<=`) - Date and Date/Time fields: equals and comparison; the value must be a full ISO-8601 date-time with milliseconds and a timezone offset (e.g. `cf_renewDate%3C%3D2026-01-01T00:00:00.000Z`). Date-only values such as `2026-01-01` are rejected - Yes/No fields: equals only, value `0` (No) or `1` (Yes) - Drilldown fields: equals only, integer value - Multi-select fields (List Box, User List Box): equals only, matched as a contains search over the stored selections (e.g. `cf_tags%3D%3Dred`) A custom field that does not exist, an operator unsupported for the field's type, or a value that does not match the field's type returns `400 Bad Request`.
- Order by
order_bytext - Attribute and direction to order items. One of the following fields: - `id` - `create_time` - `due_time` - `update_time` One of the following directions: - `asc` - `desc`
- Page size
page_sizenumber - Total number of items to return per pageFrom 0 to 1000.
- Page token
page_tokentext - Page token
- Fields
fieldslist - Comma-delimited list of optional Task properties to include in the response. Allowed values: custom_fieldsOne or more of:
id,title,description,type,priority,completed,create_time(Create time),modification_time(Modification time),completion_time(Completion time),due_time(Due time), and 8 more.
Outputs
dataobject- Keap response data.
Example output
{
"data": {
"next_page_token": "example",
"tasks": []
}
}Update company
Update a Company.
Inputs
- Company
company_idtextRequired - company_id
- Update mask
update_masklist - An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped.One or more of:
id,company_name(Company name),address,phone_number(Phone number),fax_number(Fax number),email_address(Email address),notes,website,custom_fields(Custom fields),create_time(Create time), and 21 more. - Address
addressobject - Address.
- Notes
notestext - Notes about the company
- Website
websitetext - The company's website URL
- Suffix
suffixtext - Name suffix
- Title
titletext - Name prefix or salutation
- Company name
company_nametext - The name of the company
- Custom fields
custom_fieldslist - Custom fields.
- Email address
email_addressobject - Email address.
- Fax number
fax_numberobject - Fax number.
- Phone number
phone_numberobject - Phone number.
- Anniversary date
anniversary_datetext - The anniversary date
- Assistant name
assistant_nametext - The name of the company contact's assistant
- Assistant phone
assistant_phonetext - The phone number of the company contact's assistant
- Billing information
billing_informationtext - Billing information for the company
- Birth date
birth_datetext - The birth date
- Contact type
contact_typetext - Type of contact
- First name
first_nametext - First name of the company contact
- Job title
job_titletext - Job title of the company contact
- Last name
last_nametext - Last name of the company contact
- Middle name
middle_nametext - Middle name of the company contact
- Preferred name
preferred_nametext - Preferred name or nickname of the company contact
- Owner ID
owner_idtext - ID of the user who owns this company
- Referral code
referral_codetext - Referral code
- Spouse name
spouse_nametext - Spouse's name
Outputs
dataobject- Keap response data.
Example output
{
"data": {
"account_id": "example",
"address": {
"country": "example",
"country_code": "example",
"field": "ADDRESS_FIELD_UNSPECIFIED",
"line1": "example",
"line2": "example",
"locality": "example",
"postal_code": "example",
"region": "example",
"region_code": "example",
"zip_code": "example",
"zip_four": "example"
},
"anniversary_date": "example",
"assistant_name": "example",
"assistant_phone": "example",
"billing_information": "example",
"birth_date": "example",
"company_name": "example",
"contact_type": "example",
"create_time": "example",
"created_by": "example",
"custom_fields": [],
"email_address": {
"email": "example",
"email_opt_status": "UNENGAGED_MARKETABLE",
"field": "EMAIL_FIELD_UNSPECIFIED",
"is_opt_in": false,
"opt_in_reason": "example"
},
"fax_number": {
"field": "FAX_NUMBER_FIELD_UNSPECIFIED",
"number": "example",
"type": "example"
},
"first_name": "example",
"groups": "example",
"id": "example",
"job_title": "example",
"last_name": "example",
"last_updated_by": "example",
"middle_name": "example",
"notes": "example",
"owner_id": "example",
"phone_number": {
"extension": "example",
"field": "PHONE_NUMBER_FIELD_UNSPECIFIED",
"number": "example",
"number_e164": "example",
"type": "example"
},
"preferred_name": "example",
"referral_code": "example",
"spouse_name": "example",
"suffix": "example",
"title": "example",
"update_time": "example",
"website": "example"
}
}Update contact
Update a Contact.
Inputs
- Contact
contact_idtextRequired - contact_id
- Update mask
update_masklist - An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped.One or more of:
addresses,anniversary_date(Anniversary date),birth_date(Birth date),company,contact_type(Contact type),create_time(Create time),custom_fields(Custom fields),email_addresses(Email addresses),family_name(Family name),fax_numbers(Fax numbers), and 30 more. - Fields
fieldslist - Comma-delimited list of Contact properties to include in the response. (Available fields are: addresses,anniversary_date,birth_date,company,contact_type,create_time, custom_fields,email_addresses,family_name,fax_numbers,given_name,id,job_title,leadsource_id, links,middle_name,notes,origin,owner_id,phone_numbers,preferred_locale,preferred_name,prefix, referral_code,score_value,social_accounts,source_type,spouse_name,suffix,tag_ids,time_zone, update_time,utm_parameters,website,account_id,assistant_name,assistant_phone, billing_information,created_by,groups,last_updated_by)One or more of:
id,links,addresses,company,origin,prefix,suffix,website,groups,update_time(Update time), and 30 more. - Addresses
addresseslist - Any item not listed here will be removed if it already exists. If an empty array is specified, all existing values will be removed.
- Company
companyobject - Company.
- Origin
originobject - Origin.
- Prefix
prefixtext - Name prefix
- Suffix
suffixtext - Name suffix
- Website
websitetext - Personal website URL
- Anniversary date
anniversary_datetext - The anniversary date
- Birth date
birth_datetext - The birth date
- Contact type
contact_typetext - Type of contact
- Custom fields
custom_fieldslist - Any item not listed here will be removed if it already exists. If an empty array is specified, all existing values will be removed.
- Email addresses
email_addresseslist - Any item not listed here will be removed if it already exists. If an empty array is specified, all existing values will be removed.
- Family name
family_nametext - Last name / surname
- Fax numbers
fax_numberslist - Any item not listed here will be removed if it already exists. If an empty array is specified, all existing values will be removed.
- Given name
given_nametext - First name
- Job title
job_titletext - Job title
- Leadsource ID
leadsource_idtext - Lead source identifier
- Middle name
middle_nametext - Middle name
- Owner ID
owner_idtext - ID of the user who owns this contact
- Phone numbers
phone_numberslist - Any item not listed here will be removed if it already exists. If an empty array is specified, all existing values will be removed.
- Preferred locale
preferred_localetext - Preferred locale
- Preferred name
preferred_nametext - Preferred name or nickname
- Referral code
referral_codetext - Referral code
- Social accounts
social_accountslist - Any item not listed here will be removed if it already exists. If an empty array is specified, all existing values will be removed.
- Source type
source_typetext - Source type.One of:
SOURCE_TYPE_UNSPECIFIED(Source type unspecified),API,APPOINTMENT,FORM_API_HOSTED(Form api hosted),FORM_API_INTERNAL(Form api internal),IMPORT,INTERNAL_FORM(Internal form),LANDING_PAGE(Landing page),MANUAL,OTHER,UNKNOWN,WEBFORM. - Spouse name
spouse_nametext - Spouse's name
- Time zone
time_zonetext - Contact's timezone
- Utm parameters
utm_parametersobject - Utm parameters.
- Assistant name
assistant_nametext - Assistant's name
- Assistant phone
assistant_phonetext - Assistant's phone number
- Billing information
billing_informationtext - Billing information
Outputs
dataobject- Keap response data.
Example output
{
"data": {
"account_id": "example",
"addresses": [],
"anniversary_date": "example",
"assistant_name": "example",
"assistant_phone": "example",
"billing_information": "example",
"birth_date": "example",
"company": {
"company_name": "example",
"id": "example"
},
"contact_type": "example",
"create_time": "example",
"created_by": "example",
"custom_fields": [],
"email_addresses": [],
"family_name": "example",
"fax_numbers": [],
"given_name": "example",
"groups": "example",
"id": "example",
"job_title": "example",
"last_updated_by": "example",
"leadsource_id": "example",
"links": [],
"middle_name": "example",
"origin": {
"date": "example",
"ip_address": "example"
},
"owner_id": "example",
"phone_numbers": [],
"preferred_locale": "example",
"preferred_name": "example",
"prefix": "example",
"referral_code": "example",
"score_value": "example",
"social_accounts": [],
"source_type": "SOURCE_TYPE_UNSPECIFIED",
"spouse_name": "example",
"suffix": "example",
"tag_ids": [],
"time_zone": "example",
"update_time": "example",
"utm_parameters": [],
"website": "example"
}
}Update tag
Update a Tag.
Inputs
- Tag
tag_idtextRequired - tag_id
- Update mask
update_masklist - An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped.One or more of:
name,description,category. - Name
nametext - Name of the tag, up to 255 characters will be saved
- Description
descriptiontext - Description of the tag
- Category
categoryobject - Category.
Outputs
dataobject- Keap response data.
Example output
{
"data": {
"category": {
"id": "example"
},
"create_time": "example",
"description": "example",
"id": "example",
"name": "example",
"update_time": "example"
}
}Update task
Update a Task.
Inputs
- Task
task_idtextRequired - task_id
- Update mask
update_masklist - An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped.One or more of:
id,title,description,type,priority,completion_time(Completion time),due_time(Due time),remind_time_mins(Remind time mins),assigned_to_user_id(Assigned to user id),last_updated_by_user_id(Last updated by user id), and 5 more. - Fields
fieldslist - Comma-delimited list of optional Task properties to include in the response. Allowed values: custom_fieldsOne or more of:
id,title,description,type,priority,completed,create_time(Create time),modification_time(Modification time),completion_time(Completion time),due_time(Due time), and 8 more. - Title
titletext - Task title
- Description
descriptiontext - Task description
- Type
typetext - Task type
- Priority
prioritytext - Task priorityOne of:
CRITICAL,ESSENTIAL,NONESSENTIAL. - Completed
completedtrue/false - Whether task is completed
- Completion time
completion_timetext - Completion timestamp (ISO-8601)
- Due time
due_timetext - Due date/time (ISO-8601)
- Remind time mins
remind_time_minsnumber - Value in minutes before start_date to show pop-up reminder.One of:
5,10,15,30,60,120,240,480,1440,2880. - Assigned to user ID
assigned_to_user_idtext - Assigned user ID
- Contact
contact_idtext - Associated contact ID
- Opportunity ID
opportunity_idtext - Associated opportunity ID
- Accepted
acceptedtrue/false - Whether the task has been accepted. Defaults to false
- Custom fields
custom_fieldslist - Custom field values for the task. An empty array resets all custom fields to their defaults.
Outputs
dataobject- Keap response data.
Example output
{
"data": {
"accepted": false,
"assigned_to_user_id": "example",
"completed": false,
"completion_time": "example",
"contact_id": "example",
"create_time": "example",
"created_by_user_id": "example",
"custom_fields": [],
"description": "example",
"due_time": "example",
"id": "example",
"last_updated_by_user_id": "example",
"modification_time": "example",
"opportunity_id": "example",
"priority": "CRITICAL",
"remind_time_mins": 5,
"title": "example",
"type": "example"
}
}