Skip to main content
POST
Search LinkedIn messages

Authorizations

Authorization
string
header
required

Access token issued by gtm.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Body

application/json

Request body of search_linkedin_messages.

filter
object
include
enum<string>[]

Relations to eager-load (see entity Includes).

Available options:
linkedin_conversation,
linkedin_account
sort
object
page_size
integer

0..200, default 50. page_size=0 = count-only, page_size=1 = getFirst.

Required range: 0 <= x <= 200
cursor
string | null

Opaque forward cursor from a previous response pagination.next_cursor.

Response

search success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
search
items
object[]
required
pagination
object
required
applied_filters
object
required
includes
string[]
required
meta
object
required
counts
object