LinkedIn · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for LinkedIn Recruiter System Connect Data Retrieval API

3 actions 3 updates phrasing extends openapi/linkedin-data-retrieval-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for LinkedIn's API. It is a proposal applied on top of the contract, not a document LinkedIn publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/v2/exportedCandidates'].get
$.paths['/v2/seats'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for LinkedIn Recruiter System Connect Data Retrieval API
  version: 1.0.0
extends: openapi/linkedin-data-retrieval-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/v2/exportedCandidates'].get
  update:
    x-apievangelist-phrasing:
      intent: Get candidates exported with One-Click Export
      effect: read
      questions:
      - Which candidate profiles came through a One-Click Export request?
      - Can I retrieve the profile data for an exported candidate?
      instructions:
      - text: Get exported candidate profiles for request {requestId}.
        slots:
          requestId: query.requestId
      - text: Retrieve the One-Click Export result {requestId}.
        slots:
          requestId: query.requestId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/seats'].get
  update:
    x-apievangelist-phrasing:
      intent: List Recruiter seat holders on a contract
      effect: read
      questions:
      - Who holds Recruiter seats on our contract?
      - Can I list only active seat holders with their emails?
      instructions:
      - text: List seat holders on contracts {contracts}.
        slots:
          contracts: query.contracts
      - text: Show {count} active={active} seat holders for {contracts} from {start}.
        slots:
          count: query.count
          active: query.active
          contracts: query.contracts
          start: query.start
      method: generated
      generated: '2026-09-26'