List users with the Keap API
Lists the users of the Keap app in users, with id, names, email addresses, admin and status, and next_page_token for the following page. Their id is the owner_id, user_id and assigned_to_user_id the other tools take.
- Identifier
- keap_list_users
The request
POST https://connect.reportei.com/api/tools/keap_list_users/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"filter": "<filter>"
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | No | Filters joined by ;, each one field==value, for example email==ana@acme.com. Fields: email, given_name, include_inactive (true or false), include_partners (true or false) and user_ids (comma-separated). |
| order_by | string | No | Field and direction separated by a space: create_time, email or name, then asc or desc, for example name asc. |
| page_size | integer | No | Users per page, up to 100. |
| page_token | string | No | The next_page_token of the previous response. Omit it on the first page. |
Supported connections
Your customer connects their Keap account once, with one of the modes below. The same connection serves every tool of the toolkit.
OAuth with your product's app
You register your product's OAuth app once, with POST /api/merchants/credentials/keap, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/keap_list_users. It becomes your agent's tool definition with no conversion.
Other Keap tools
- List contactsGETLists the contacts of the Keap app in contacts, with next_page_token for the following page. Without fields, each contact comes with a default set of properties. Filter by email, name, ids and other fields with filter.
- Create contactPOSTCreates a contact and returns it. It needs at least one item in email_addresses, phone_numbers or addresses. With duplicate_option, a matching contact is updated instead of a new one being created.
- Update contactPATCHUpdates the fields sent and returns the contact. Fields left out keep their values, but each list sent (email_addresses, phone_numbers, addresses) replaces the whole list.
- List tagsGETLists the tags of the Keap app in tags, with id, name, description and category, and next_page_token for the following page.
- Create tagPOSTCreates a tag and returns it with its id. The tag is not applied to anyone until Apply tag.
- Apply tagPOSTApplies a tag to one or more contacts. Applying a tag can start the automations of the Keap app that listen to it, such as email sequences.
- Remove tagPOSTRemoves a tag from one or more contacts. The tag itself stays in the Keap app.
- List opportunitiesGETLists the opportunities of the sales pipeline in opportunities, each with its contact, stage and user, and next_page_token for the following page.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
