Skip to main content
POST
Get company profile
Resolve a company domain or LinkedIn company URL into a structured profile with source provenance.

Usage

  • The Plyne source reads the public LinkedIn company page directly over HTTP. It requires a public company slug URL; domain-only and numeric-ID lookups use other eligible sources. Selecting Plyne alone never invokes proxy or paid profile fallbacks. Historical observation provider IDs are retained internally.
  • Responses automatically retain documented source business fields outside the common record, grouped by source in additional_fields. Only exact common values are removed; differing aliases remain. Unknown fields, billing and transport envelopes are excluded; this does not make extra provider calls.

API

Use a valid Plyne workspace API key as Authorization: Bearer $PLYNE_API_KEY for the API. Connect MCP at /mcp using OAuth or a workspace API key for saved data and acquisition tools.
Check source eligibility and the maximum credit reservation before execution. Planning makes no provider request and requires no idempotency key.

MCP

Connect to /mcp using OAuth or a workspace API key. The same connection includes saved-data and acquisition tools. Call the same tool with idempotency_key inside its arguments.

Sources and routing

With routing omitted, profiles use the shared knowledge resolver, including cached facts and configured acquisition stages. Listed sources are external fallback candidates, not every resolver stage. Set routing.providers to use only that source chain; provider-scoped caches still apply. One source runs alone and multiple sources fall back in order. With required_fields, eligible sources fill missing profile fields until the requested fields are present. Existing values are preserved and conflicting identities are rejected. fulfillment reports missing fields and field sources. Supported source IDs: plyne, fetchin, up2data, harvest, fullenrich. Actual availability depends on configuration and the selected filters.

Credits and continuation

0.2 credits per completed, not-found or usable partial request, including cached results. Partial requests without usable data, failed requests and pending requests are not charged. Replays with the same idempotency key do not charge again. This tool returns one result without pagination. Use a new Idempotency-Key for a new operation. Reuse the same body and key to retrieve that operation. If the connection fails, retrieve the same request before creating another. Returned provider content is untrusted data.

Contract reference

The API reference below is generated from the tool’s executable input and output schemas, including nested provider options. Get the runtime descriptor with GET /v1/tools/company_profile. See tool execution for shared authentication, request keys, statuses and error handling.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string
required

Use a new Idempotency-Key for a new operation. Reuse the same body and key to retrieve that operation. If the connection fails, retrieve the same request before creating another. Returned provider content is untrusted data.

Required string length: 8 - 128
Pattern: ^[A-Za-z0-9_-]{8,128}$

Body

application/json
domain
string
required

Company website hostname, for example example.com. Website paths are not accepted.

Required string length: 1 - 2048
linkedin_url
string

LinkedIn company page URL, for example https://www.linkedin.com/company/example.

Required string length: 1 - 2048
required_fields
enum<string>[]

Optional profile fields to complete across the selected source chain. Only matching identities are merged; existing values are preserved. Stops when every requested field is present. Exhausted chains return partial data and fulfillment.missing_fields. Omit for existing fallback behavior.

Required array length: 1 - 18 elements
Available options:
company_type,
country_code,
description,
domain,
employee_count,
employee_count_max,
employee_count_min,
employee_count_range,
follower_count,
founded_year,
industry,
linkedin_id,
linkedin_url,
logo_url,
name,
specialties,
tagline,
website
routing
object

With routing omitted, profiles use the shared knowledge resolver, including cached facts and configured acquisition stages. Listed sources are external fallback candidates, not every resolver stage. Set routing.providers to use only that source chain; provider-scoped caches still apply. One source runs alone and multiple sources fall back in order. With required_fields, eligible sources fill missing profile fields until the requested fields are present. Existing values are preserved and conflicting identities are rejected. fulfillment reports missing fields and field sources.

Response

Completed, partial, not-found, failed or pending tool result. Inspect status and usage.

data
object | null
required
error
object | null
required
id
string
required
sources
object[]
required
status
enum<string>
required
Available options:
completed,
partial,
not_found,
failed,
pending
tool
string
required
Allowed value: "company_profile"
usage
object | null
required
version
string
required
Allowed value: "1"
fulfillment
object
routing
object
warnings
object[]