List people with the Crisp API

Lists or searches the contacts (people profiles) of a workspace, with people_id, email, name, company, segments and notepad. Pages start at 1, and a page with fewer items than per_page is the last one.

Identifier
crisp_list_people

The request

POST https://connect.reportei.com/api/tools/crisp_list_people/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "website_id": "<website_id>",
    "page_number": 1
  }
}

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

ParameterTypeRequiredDescription
website_idstringYesId of the workspace, from List websites.
page_numberintegerYesPage number, starting at 1.
per_pageintegerNoContacts per page, from 20 to 50. Defaults to 20.
search_textstringNoQuick search text, like a name or an email.
sort_fieldstringNoField to sort on, like nickname.
sort_orderstringNoSort order.Values: ascending, descending
filter_date_startstringNoOnly contacts created from this moment on, in ISO 8601.
filter_date_endstringNoOnly contacts created up to this moment, in ISO 8601.

Supported connections

Your customer connects their Crisp account once, with one of the modes below. The same connection serves every tool of the toolkit.

Username and password

Your customer enters the app credentials on a Connect screen, or your system sends them with POST /api/customer-toolkits, with no screen.

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/crisp_list_people. It becomes your agent's tool definition with no conversion.

Other Crisp tools

See all 13 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.