Skip to main content
GET
Search everything

Authorizations

api_access_token
string
header
required

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

id
integer
required

The numeric ID of the account

Query Parameters

q
string
required

The search term. Matched against message content, contact name, email and phone number, and article title and body.

Example:

"plans"

page
integer
default:1

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.

payload
object

Results grouped by type.