Skip to main content
POST
Search LinkedIn accounts

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_accounts.

filter
object
include
enum<string>[]

Relations to eager-load (see entity Includes).

antidetect_browser carries the sender LOGIN and runtime state (browser status login_issue means signed out of LinkedIn, restricted means signed out and the public profile is gone, a LinkedIn restriction; also error_reason, logout_count, last_logout_at). The account item alone cannot answer "is this sender signed in": its status field is lifecycle. Health data: linkedin_account_smart_limits (budgets and holds), linkedin_account_snapshot (latest warmup score), linkedin_account_quota_hits / linkedin_account_block_log (last 50 incident rows each), *_counts (child tallies). initial_sync is the first sync of a new account, null once it is done: state (syncing | waiting_for_reads = the day's reads are used and it goes on by itself at resumes_at | waiting_for_browser = start the browser or sign in again), conversations_synced, estimated_completion_at and estimated_days_left (0 = today; both null in the first minutes and while the browser is down). A large account takes days on purpose: reading it in one go is not safe, so the platform paces it. Until it is done outbound verbs wait and the limits are provisional, set when it finishes. Say that, not that something is stuck.

Available options:
antidetect_browser,
linkedin_account_smart_limits,
linkedin_account_snapshot,
linkedin_account_quota_hits,
linkedin_account_block_log,
linkedin_account_block_log_counts,
linkedin_connections_counts,
linkedin_connection_requests_counts,
linkedin_connection_invitations_counts,
linkedin_conversations_counts,
linkedin_followers_counts,
initial_sync
sort
object
page_size
integer

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

Required range: 0 <= x <= 500
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