Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.signalhire.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

By adding withoutContacts: true to a Person API request, a profile’s public data can be retrieved — name, location, work experience, education, skills — without consuming standard contact credits. The LinkedIn profile link is still included in the response. This is useful when only profile metadata is needed without contact information.
This mode uses a separate credit type. Contact support@signalhire.com to purchase these credits.

​
Request Parameters

Uses the same endpoint and parameters as Retrieve Person Data, with withoutContacts set to true. All other parameters, response codes, and rate limits apply identically. withoutContacts can also be combined with withoutWaterfall: true for a fully synchronous flow — profile metadata returned immediately without contacts and without needing a callback server. In this case callbackUrl must not be included.

​
Request Example (Async with Callback)

curl -X POST https://www.signalhire.com/api/v1/candidate/search \
-H 'apikey: your_secret_api_key' \
--data '{
"items": ["https://www.linkedin.com/in/profile1"],
"withoutContacts": true,
"callbackUrl": "https://www.yourdomain.com/yourCallbackUrl"
}'

​
Request Example (Sync without Callback)

To retrieve profile metadata synchronously without contacts and without a callback server, combine withoutContacts: true with withoutWaterfall: true: 
curl -X POST https://www.signalhire.com/api/v1/candidate/search \
-H 'apikey: your_secret_api_key' \
--data '{
"items": ["https://www.linkedin.com/in/profile1"],
"withoutContacts": true,
"withoutWaterfall": true
}'

​
Response

The callback format is identical to the standard Retrieve Person Data response, but contact fields (phone numbers, email addresses) will be absent from the candidate object. The LinkedIn profile link remains available in the social array. See Candidate Object for the full field reference. When using sync mode (withoutWaterfall: true), results are returned directly in the response body in the same format — no callback is sent.

​
Callback Delivery

Callback delivery rules are identical to the standard mode — see Callback Delivery for details on timeouts, retries, and failed delivery notifications. This section applies only to async mode. When using withoutWaterfall: true, there is no callback.

​
Checking Credits

This mode uses a separate credit type, independent of standard contact credits. To check the remaining without-contacts balance, use the withoutContacts=true parameter with the Get Remaining Credits endpoint. The X-Credits-Left header is included in every response and automatically reflects the credit type matching the request — without-contacts credits when withoutContacts: true is set, standard credits otherwise.