Search parties with the Capsule CRM API

Searches people and organisations with the same results as the global search of Capsule, by a name, a postcode or a phone number, for example. Paginate with page, starting at 1, and perPage, up to 100.

Identifier
capsule_search_parties

The request

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "q": "<q>"
  }
}

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
qstringYesText to search for, such as a name, a postcode or a phone number.
pageintegerNoPage to return, starting at 1.
perPageintegerNoParties per page, up to 100. The default is 50.
embedstringNoComma-separated extra data to include: tags, fields, organisation or missingImportantFields.

Supported connections

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

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/capsule, 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/capsule_search_parties. It becomes your agent's tool definition with no conversion.

Other Capsule CRM tools

See all 15 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.