Skip to main content
GET
Search people to message

Authorizations

Authorization
string
header
required

A member credential in the Authorization: Bearer header: a member session JWT, a portal JWT whose login is linked to a membership in that company, or a member token. The credential alone identifies the member and company.

Query Parameters

q
string
required

At least two characters once trimmed of surrounding whitespace.

Required string length: 2 - 100
limit
integer
default:10

Most results of each kind. Defaults to 10.

Required range: 1 <= x <= 25

Response

Matching people.

People the member may message.

status
integer
required
data
object[]
required
meta
object
required

Envelope metadata present on every response.