Skip to main content
POST
Create LinkedIn auto-scrape

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

linkedin_account_sid
string
required

Executor LinkedIn account sid (ln_ac_...): whose browser paginates the source.

Required string length: 18
Pattern: ^ln_ac_
title
string | null

Human label for the list view. Server derives "{result_kind} {source_method}" when omitted.

Maximum string length: 255
url
string

LinkedIn or Sales Navigator people/company SEARCH url. Mutually exclusive with source_method plus source_input.

Maximum string length: 2048
source_method
enum<string>

The paginated verb to replay. Required (with source_input) for every non-search source.

Available options:
search-people-by-url,
search-people-by-params,
search-sales-nav-people-by-url,
search-sales-nav-people-by-params,
similar-profiles,
company-employees,
company-decision-makers,
get-post-commenters,
get-post-reactors,
get-post-resharers,
search-companies-by-url,
search-companies-by-params,
search-sales-nav-companies-by-url,
search-sales-nav-companies-by-params,
similar-companies
source_input
object

The verb's own arguments. One key is mandatory per family: url, filters, anchor_company_ln_id, anchor_nickname (similar-profiles takes the vanity slug, never a URN), or activity_urn. filters takes the SAME schema as the matching scrape_linkedin_search_*_by_params tool (see it for the facet vocabulary and typeahead workflow).

replay_frequency
enum<string> | null

Cadence: hourly | daily | weekly | monthly. Omit or null for a one-shot job that runs once.

Available options:
hourly,
daily,
weekly,
monthly
mass_action_sid
string | null

Standing mass-action new leads enrol into. Cross-checked for same team, live, and target family compatible with result_kind.

Required string length: 18
Pattern: ^ma_ac_

Response

create success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
create
item
object
required
already_exists
boolean
required
meta
object
required