Skip to main content
GET
Search the share targets

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, an opaque member token, or a verified One Auth identity access token. The credential alone identifies the member and company. Member session and portal JWTs are read-only and are refused with 403 on every write.

Headers

If-None-Match
string

ETag from a previous response.

Query Parameters

q
string

What a member's name starts with, or their email address where the company's policy shows it. Leading and trailing spaces are ignored. Blank lists the first members the caller may share with. Otherwise it needs 3 to 200 characters and is refused with 422 outside that range. Searching also needs the first word or the rest of the query to have 3 characters; a query where neither does matches no members, and the other targets are still returned.

Maximum string length: 200

Response

The share targets.

Whom the member may share a site with.

status
integer
required

HTTP status code (mirrors the response status line).

data
object
required

Whom the member may share a site with.

meta
object
required

Envelope metadata present on every response.