Skip to main content
POST
Find phone number
Start a durable public-data operation. Repeat the same request and Idempotency-Key to retrieve progress; never create a new key just to poll. Source job identifiers are scoped internally to this workspace.

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

Omit routing to use eligible sources in the default order. Set routing.providers to an ordered chain, or one source to run only that source. Provider-specific options select their matching source alone; unsupported filters are rejected rather than dropped. Supported source IDs: fullenrich. Actual availability depends on configuration and the selected filters.

Credits and continuation

The /plan quote is the maximum reserved credits for these settings. Polls and idempotent replays do not charge again. Empty and failed results release the reservation. This is a long-running operation. A pending result keeps its credit reservation. Repeat the original body and idempotency key to check progress; polling does not create another provider job or charge again. 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/phone. 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
url
string
required

Public contact identity. Supply a LinkedIn profile URL or first_name, last_name and company domain.

Required string length: 1 - 10000
company_name
string

Public contact identity. Supply a LinkedIn profile URL or first_name, last_name and company domain.

Required string length: 1 - 10000
domain
string

Public contact identity. Supply a LinkedIn profile URL or first_name, last_name and company domain.

Required string length: 1 - 10000
first_name
string

Public contact identity. Supply a LinkedIn profile URL or first_name, last_name and company domain.

Required string length: 1 - 10000
last_name
string

Public contact identity. Supply a LinkedIn profile URL or first_name, last_name and company domain.

Required string length: 1 - 10000
provider_options
object
routing
object

Optional source chain. One source runs alone; multiple sources are tried in order. All selected sources must support the request. Provider options require a matching one-source chain.

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: "phone"
usage
object | null
required
version
string
required
Allowed value: "1"
fulfillment
object
routing
object
warnings
object[]