Skip to main content
POST

Authorizations

Authorization
string
header
required

Pass Authorization: Bearer <credential>, where the credential is either:

  • an API key (sk_…), generated by an organization admin in Settings, for scripts and automation;
  • an access token from tth auth login (the TalkToHumans CLI), which any member of the workspace can use.

Both resolve to the same organization and user. A login token acts in the user's workspace: one with no workspace yet returns 403 workspace_setup_required, and one in several workspaces returns 403 forbidden (use an API key instead).

Body

application/json

Provide exactly one target: contact_id, provider_participant_id, linkedin_url, or public_identifier.

contact_id
string
required

Contact ID returned by GET /v1/contacts.

Pattern: ^[1-9][0-9]*$
account_id
string

LinkedIn account ID returned by GET /v1/accounts. Required when the organization has multiple LinkedIn accounts.

Pattern: ^[1-9][0-9]*$
provider_participant_id
string

LinkedIn participant ID, such as urn:li:fsd_profile:abc.

linkedin_url
string<uri>

LinkedIn profile URL.

public_identifier
string

LinkedIn public identifier from a profile URL.

force
boolean
default:false

Refresh cached enrichment data even when fresh data is already available.

Response

LinkedIn profile and primary company enrichment data.

data
object
required