Kick off LinkedIn-backed team discovery for a publisher
POST /publishers/{id}/find_linkedin_users
POST /publishers/{id}/find_linkedin_users
Operation
POST
/publishers/{id}/find_linkedin_users
Enqueues DiscoverPublisherLinkedinPeopleJob to find publisher staff on LinkedIn and optionally pre-populate guessed work emails. Limited to HiEnergy admins or the publisher's own account admins.
Operation ID:
findPublisherLinkedinUsers
·
Tags: Publishers
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id
|
path | Yes | string | — |
Request Body
Required: No
{
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"minimum_people": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "Minimum number of people to try to discover (default 5)"
},
"apply_guessed_work_emails": {
"type": "boolean",
"description": "When true, persists the guessed work emails to the newly created users",
"default": false
}
}
}
}
}
}Responses
Content Types
application/json
{
"description": "Discovery completed synchronously; returns the publisher plus discovery counts.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"data",
"meta"
],
"properties": {
"data": {
"$ref": "#/components/schemas/Publisher"
},
"meta": {
"type": "object",
"required": [
"publisher_id",
"minimum_people",
"apply_guessed_work_emails",
"created_user_count",
"matched_user_count",
"discovered_people_count",
"searchkick_warnings"
],
"properties": {
"publisher_id": {
"type": "integer",
"description": "ID of the publisher that was searched."
},
"minimum_people": {
"type": "integer",
"description": "Effective minimum_people used for the search (after clamping to [1, 100])."
},
"apply_guessed_work_emails": {
"type": "boolean",
"description": "Echo of the apply_guessed_work_emails flag used for the search."
},
"created_user_count": {
"type": "integer",
"description": "Number of new User rows created from LinkedIn matches."
},
"matched_user_count": {
"type": "integer",
"description": "Number of existing Users matched to LinkedIn people."
},
"discovered_people_count": {
"type": "integer",
"description": "Total number of LinkedIn people returned by the AI search."
},
"searchkick_warnings": {
"type": "array",
"description": "Non-fatal Searchkick warnings raised while syncing indexes.",
"items": {
"type": "string"
}
}
}
}
}
}
}
}
}{
"$ref": "#/components/responses/Unauthorized"
}{
"$ref": "#/components/responses/Forbidden"
}{
"$ref": "#/components/responses/NotFound"
}Content Types
application/json
{
"description": "OpenAI is not configured for this feature.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}Content Types
application/json
{
"description": "LinkedIn discovery failed upstream (OpenAI remote or parse error).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}API Playground
The in-page tester only supports GET. For POST, use the sample curl below or the dedicated resource docs (e.g. Contacts, Link Builder).
Sign in to enable live testing with your API key.
| Action | Method | Endpoint | Description |
|---|---|---|---|
| Kick off LinkedIn-backed team discovery for a publisher | POST |
/api/v1/publishers/1/find_linkedin_users |
OpenAPI operationId: findPublisherLinkedinUsers. |
Example request (replace YOUR_API_KEY or sign in above):
curl -X POST "https://app.hienergy.ai/api/v1/publishers/1/find_linkedin_users" \
-H "X-Api-Key: YOUR_API_KEY" \
-H "Accept: application/json"
-H "Content-Type: application/json" \
-d '{}'