> ## Documentation Index > Fetch the complete documentation index at: https://docs.getsales.io/llms.txt > Use this file to discover all available pages before exploring further. # Read LinkedIn person > Read one LinkedIn profile by its slug or pasted link, for the person's own card: name, photo (avatar_url), headline, the current role and company (its slug or company_ln_id for read_linkedin_company), location, positions, languages, the identity axes; nothing written. The corpus answers free; a pool read is comped for a workspace's first three, then 5 credits. alive false with reason profile_not_found, profile_unreadable or pool_unavailable (retry_after). A person row is update_person. Contract: - MCP tool `read_linkedin_person`, registry package `mcp.playtables/people`, mount `playtables.people`. - Operation `action`, response envelope `action`. - Flags: read only. ## OpenAPI ````yaml /api-reference/playtables/openapi.yaml post /api/people/read-linkedin openapi: 3.0.3 info: title: 'GetSales public contract: gs.service.playtables' description: >- The data platform and the outreach engine: tables of people and companies, their enrichment columns, cells and runs, the data sources that feed them, sender profiles, the stoplist, the activity feed, the credit ledger, and the multichannel workflows with their per-person journeys and tasks. GENERATED. This document is projected from the Zod MCP tool registry in `product/mcp/gs.mcp` (one tool per public endpoint, 1:1). Do not edit it by hand; edit the tool definition and regenerate with `pnpm openapi:public`. Surface: the public `/api` contract of `gs.service.playtables`, 142 operations. This is the only OpenAPI document the platform publishes. Internal (`/internal`) and health endpoints are deliberately absent: they are not part of any contract, they can change without notice, and the service source is their only description. Conventions: - Auth is a bearer JWT, optionally narrowed by the `Team-SID` header. - Every success body is an MCP envelope: `success: true` plus one typed `operation` shape (`search`, `get`, `create`, `update`, `delete`, `metrics`, `group_by`, `action`), and a `meta` block with `trace_id` for support. - Every failure is the same `McpError` envelope with a code from a fixed 16-code taxonomy, so a client maps errors once. - Lists page with `page_size` (0 to 500, default 50) plus an opaque forward `cursor`; `page_size: 0` returns counts only. - On `GET` and `DELETE`, object-valued query parameters (`filter`, `sort`) travel as JSON text and array-valued ones repeat as `name[]=value`. - The MCP-only `_meta` field (usage analytics) never reaches the backend and is not part of this contract. version: '1.0' contact: name: GetSales url: https://getsales.io email: support@getsales.io license: name: Proprietary url: https://getsales.io/terms servers: - url: https://beta.getsales.io/playtables/v1 description: >- Production (the gateway path on the beta ring; the origin is provisioned per DEPLOY_MAP.md) security: - BearerJwt: [] TeamSid: [] tags: - name: activities description: >- Registry package `mcp.playtables/activities`, served on MCP mount `playtables.journeys`. - name: activity_objects description: >- Registry package `mcp.playtables/activity_objects`, served on MCP mount `playtables.people`. - name: companies description: >- Registry package `mcp.playtables/companies`, served on MCP mount `playtables.people`. - name: credit_ledger_entries description: >- Registry package `mcp.playtables/credit_ledger_entries`, served on MCP mount `id.billing`. - name: data_source_items description: >- Registry package `mcp.playtables/data_source_items`, served on MCP mount `playtables.sources`. - name: data_sources description: >- Registry package `mcp.playtables/data_sources`, served on MCP mount `playtables.sources`. - name: notes description: >- Registry package `mcp.playtables/notes`, served on MCP mount `playtables.pipeline`. - name: people description: >- Registry package `mcp.playtables/people`, served on MCP mount `playtables.people`. - name: pipeline_stages description: >- Registry package `mcp.playtables/pipeline_stages`, served on MCP mount `playtables.pipeline`. - name: plays description: >- Registry package `mcp.playtables/plays`, served on MCP mount `playtables.pipeline`. - name: playtable_field_values description: >- Registry package `mcp.playtables/playtable_field_values`, served on MCP mount `playtables.columns`. - name: playtable_fields description: >- Registry package `mcp.playtables/playtable_fields`, served on MCP mount `playtables.columns`. - name: playtable_runs description: >- Registry package `mcp.playtables/playtable_runs`, served on MCP mount `playtables.columns`. - name: playtable_views description: >- Registry package `mcp.playtables/playtable_views`, served on MCP mount `playtables.tables`. - name: playtables description: >- Registry package `mcp.playtables/playtables`, served on MCP mount `playtables.tables`. - name: result_pages description: >- Registry package `mcp.playtables/result_pages`, served on MCP mount `playtables.tables`. - name: sender_profiles description: >- Registry package `mcp.playtables/sender_profiles`, served on MCP mount `playtables.sources`. - name: stoplist_entries description: >- Registry package `mcp.playtables/stoplist_entries`, served on MCP mount `playtables.stoplist`. - name: tags description: >- Registry package `mcp.playtables/tags`, served on MCP mount `playtables.pipeline`. - name: workflow_attachments description: >- Registry package `mcp.playtables/workflow_attachments`, served on MCP mount `playtables.workflows`. - name: workflow_records description: >- Registry package `mcp.playtables/workflow_records`, served on MCP mount `playtables.journeys`. - name: workflow_sources description: >- Registry package `mcp.playtables/workflow_sources`, served on MCP mount `playtables.workflows`. - name: workflow_tasks description: >- Registry package `mcp.playtables/workflow_tasks`, served on MCP mount `playtables.journeys`. - name: workflow_versions description: >- Registry package `mcp.playtables/workflow_versions`, served on MCP mount `playtables.workflows`. - name: workflows description: >- Registry package `mcp.playtables/workflows`, served on MCP mount `playtables.workflows`. paths: /api/people/read-linkedin: post: tags: - people summary: Read LinkedIn person description: >- Read one LinkedIn profile by its slug or pasted link, for the person's own card: name, photo (avatar_url), headline, the current role and company (its slug or company_ln_id for read_linkedin_company), location, positions, languages, the identity axes; nothing written. The corpus answers free; a pool read is comped for a workspace's first three, then 5 credits. alive false with reason profile_not_found, profile_unreadable or pool_unavailable (retry_after). A person row is update_person. Contract: - MCP tool `read_linkedin_person`, registry package `mcp.playtables/people`, mount `playtables.people`. - Operation `action`, response envelope `action`. - Flags: read only. operationId: read_linkedin_person requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ReadLinkedinPersonRequest' responses: '200': description: '`action` success envelope.' content: application/json: schema: $ref: '#/components/schemas/ReadLinkedinPersonResponse' 4XX: $ref: '#/components/responses/McpClientError' 5XX: $ref: '#/components/responses/McpServerError' components: schemas: ReadLinkedinPersonRequest: type: object description: Request body of `read_linkedin_person`. properties: ln_nickname: type: string minLength: 1 maxLength: 2048 description: >- The profile slug (public identifier), or the linkedin.com/in/ link as the person pasted it; parsed at the edge, never stored. required: - ln_nickname ReadLinkedinPersonResponse: type: object properties: success: type: boolean enum: - true operation: type: string enum: - action action: type: string description: kebab-case verb; matches the route segment. item: {} result: type: object properties: alive: type: boolean description: LinkedIn served the profile. comped: type: boolean description: >- The read ran on the onboarding allowance at price 0 (the first three pool reads of a team). person: type: object nullable: true properties: full_name: type: string nullable: true headline: type: string nullable: true role_title: type: string nullable: true description: The current position's title. company_name: type: string nullable: true description: The current company's name. company_ln_nickname: type: string nullable: true description: >- The current company's page slug: what read_linkedin_company takes. company_ln_id: type: string nullable: true description: >- The current company's numeric LinkedIn id, as digits: what read_linkedin_company takes as ln_id when the slug is unknown. location: type: string nullable: true avatar_url: type: string nullable: true description: >- The photo, as an https address on our own store (never a LinkedIn address); null when the page shows none. update_user_profile takes it as avatar_url. positions: type: array items: type: object properties: title: type: string nullable: true company: type: string nullable: true company_ln_nickname: type: string nullable: true description: >- This position's company page slug, when the profile names it: what read_linkedin_company takes when the person runs two companies and picks this one. company_ln_id: type: string nullable: true description: >- This position's company id, as digits, when the profile names it: read_linkedin_company's ln_id when the slug is unknown. from: type: string nullable: true description: As LinkedIn wrote it ("Mar 2021"). to: type: string nullable: true description: >- Null on the position still running: two or more such positions under different companies is the person running two companies, and which one the workspace is for is theirs to say. required: - title - company - company_ln_nickname - company_ln_id - from - to description: The experience, newest first. languages: type: array items: type: string description: >- The Languages card when the profile carries one; empty otherwise. ln_member_id: type: integer nullable: true ln_id: type: string nullable: true description: The profile URN. ln_nickname: type: string nullable: true description: The public identifier (slug), never a URL. required: - full_name - headline - role_title - company_name - company_ln_nickname - company_ln_id - location - avatar_url - positions - languages - ln_member_id - ln_id - ln_nickname description: The profile's words and axes when alive. reason: type: string description: >- Why alive is false: profile_not_found (no profile at the identifier), profile_unreadable (LinkedIn would not serve it) or pool_unavailable (no capacity: ask again after retry_after). retry_after: anyOf: - type: string - type: number - {} description: 'With pool_unavailable: when to ask again.' required: - alive meta: type: object properties: trace_id: type: string description: UUID v7; same 128-bit value as the X-Trace-Id header. span_id: type: string pattern: ^[0-9a-f]{16}$ description: 16 hex chars, root span of this request. timestamp: type: string description: ISO 8601 UTC (Y-m-dTH:i:sZ), response time. duration_ms: type: integer minimum: 0 description: Server-side wall clock. team_sid: type: string nullable: true description: >- The team this call ran in (the token team, or the team_sid override). Null when unauthenticated; absent from pre-2026-08-20 backends. actor_type: type: string nullable: true description: >- user | agent | api_key | system. Null when unauthenticated; absent from pre-2026-08-20 backends. required: - trace_id - span_id - timestamp - duration_ms required: - success - operation - action - item - result - meta McpError: type: object properties: success: type: boolean enum: - false error: type: object properties: code: type: string enum: - validation_failed - nothing_to_update - not_found - relation_not_found - invalid_transition - limit_exceeded - payment_required - duplicate_rejected - conflict - delete_blocked - unauthorized - forbidden - rate_limited - internal_error - service_unavailable - not_implemented message: type: string recoverable: type: boolean suggestion: type: string field_errors: type: object additionalProperties: type: array items: type: object properties: rule: type: string message: type: string required: - rule - message blockers: type: array items: type: object properties: type: type: string description: >- Machine-readable blocker type (active_flow, pending_tasks, …). severity: type: string enum: - hard - soft description: >- hard = external action required; soft = acknowledge is enough. description: type: string entity_sid: type: string nullable: true count: type: integer resolution: type: string description: 'Hard: tool name to call. Soft: code for acknowledge[].' resolution_hint: type: string required: - type - severity - description - entity_sid - resolution - resolution_hint context: type: object additionalProperties: {} required: - code - message - recoverable meta: type: object properties: trace_id: type: string description: UUID v7; same 128-bit value as the X-Trace-Id header. span_id: type: string pattern: ^[0-9a-f]{16}$ description: 16 hex chars, root span of this request. timestamp: type: string description: ISO 8601 UTC (Y-m-dTH:i:sZ), response time. duration_ms: type: integer minimum: 0 description: Server-side wall clock. team_sid: type: string nullable: true description: >- The team this call ran in (the token team, or the team_sid override). Null when unauthenticated; absent from pre-2026-08-20 backends. actor_type: type: string nullable: true description: >- user | agent | api_key | system. Null when unauthenticated; absent from pre-2026-08-20 backends. required: - trace_id - span_id - timestamp - duration_ms required: - success - error responses: McpClientError: description: >- MCP error envelope. `error.code` is one of validation_failed, nothing_to_update, not_found, relation_not_found, invalid_transition, limit_exceeded, payment_required, duplicate_rejected, conflict, delete_blocked, unauthorized, forbidden, rate_limited, not_implemented. content: application/json: schema: $ref: '#/components/schemas/McpError' McpServerError: description: >- MCP error envelope with `error.code` internal_error or service_unavailable. content: application/json: schema: $ref: '#/components/schemas/McpError' securitySchemes: BearerJwt: type: http scheme: bearer bearerFormat: JWT description: >- Access token issued by gs.service.id. Its `access_identity` claim carries `team_sid`, `actor_sid` and `actor_type`, and that team scope is authoritative. TeamSid: type: apiKey in: header name: Team-SID description: >- Team scope for tokens that do not carry one. Ignored when the token already names a team. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.