Skip to main content
Use company_profile to retrieve a company profile from a LinkedIn company URL. This walkthrough uses the public Plyne company URL as an input example; the returned fields depend on the eligible source and available data.

1. Set your API key

Create a workspace API key in Developer → API Keys in the portal. Keep the key in your application environment rather than in client-side code.

2. Read the tool contract

Describe the tool before constructing a request. The descriptor includes accepted input fields, source options, output fields and billing guidance.
The company profile reference documents the same contract. Other tools can require different identities, filters or result limits.

3. Check the plan

Planning validates the input and returns source eligibility and the maximum credit quote. It makes no acquisition request and reserves no credits.
Check the returned providers and pricing. A plan does not guarantee that a source will remain available or return data when execution starts.

4. Execute once

Choose a new Idempotency-Key for this operation. The example key below is illustrative; replace it for each new operation.
Inspect status, data, sources and usage. Single-company lookups omit pagination. A not_found response is possible; company enrichment has its own billing policy, so do not assume every empty lookup is free.

5. Retrieve the same operation

Repeat the original body and key to retrieve the operation. A completed replay returns the saved result without another acquisition charge. If the connection fails or the response is incomplete, retrieve the same operation before creating a new key.

Use the same tool through MCP

Connect to /mcp with OAuth or your workspace API key. First call plan_tool with the proposed input:
Check the eligible sources and credit reservation. Then execute using these tools/call parameters, with the request key inside arguments:
When used in the same workspace with the same request and key, API and MCP refer to the same operation. See acquisition MCP for connection details.

Choose a chain

Control source order and fallback conditions.

Understand credits

Understand reservation, settlement and interrupted requests.