Skip to content

Search Copilot Mentions

POST
/copilot/mention-search

Find what can be @mentioned: documents, personas, ICPs, campaigns, teammates. FREE.

Read-only. Pass results as mentions on POST /copilot/chat.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Find documents, personas, ICPs, campaigns and teammates to @mention.

object
campaign_id
Any of:
string
mode
Any of:
string
Allowed values: global campaign account
query
string
""

Responses

200

Successful Response

object
data
required

A LIST result, open-shaped, with items always present.

The app returns a bare list from some routes and a named key from others (pages, grids, images, creatives, reports, items). Both are published: the original key is preserved AND mirrored onto items, so a client can page any Studio collection the same way without a per-route lookup table.

object
items
Array
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string