Search contacts
Contacts matched on name, email, phone number and external identifier. Results are trimmed to those five fields. Same response shape as the grouped search, with only this one key under payload.
Authorizations
This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.
Path Parameters
The numeric ID of the account
Query Parameters
The search term. Matched against message content, contact name, email and phone number, and article title and body.
"plans"
The page parameter
Response
Success
Search results, grouped by type under payload. The grouped endpoint returns all four keys; each single-type endpoint returns only its own.
Results grouped by type.