Documentation · Extract school alumni
Documentation / Data actions

Extract school alumni

Extract the list of alumni matching a school page with their profile information.

POST /v1/actions/linkedin-extract-school-alumnis/run/live

Authentication and cost

Use an API key in the Bearer header. This action costs 1 credit per returned record. The maximum result count is 100.

Request

bash
curl "$API_URL/v1/actions/linkedin-extract-school-alumnis/run/live" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Idempotency-Key: unique-linkedin-extract-school-alumnis-001" \
  -H "Content-Type: application/json" \
  -d '{
  "input": {
    "school": "Stanford University"
  },
  "max_results": 10,
  "max_credits": 10
}'
ParameterRequirement
input.schoolRequired non-empty string, at most 500 characters.
max_resultsInteger from 1 to 100. Default 10.
max_creditsOptional positive integer; must cover the requested reservation.
Idempotency-KeyRequired; 8–128 letters, numbers, underscores, hyphens, or colons.

Output fields

The response contains an output array. Available record fields include:

  • full_name
  • headline
  • linkedin_profile_handle
  • sales_navigator_profile_id
  • linkedin_profile_id
  • connection_degree
  • profile_image_url
  • linkedin_profile_url
  • school_name
  • sales_navigator_profile_url
  • linkedin_people_post_search_url

Fields not available from the source are omitted. Your parser must tolerate absent properties and empty arrays. Examples are illustrative, not live customer data.

Completion and retries

Both 200 and 202 are valid responses. Read status: a live call can remain queued when capacity is busy. Poll the run until it reaches a terminal state. A terminal failed run can have HTTP 200; inspect its error and status, not just the HTTP code.

Reuse the same idempotency key and request body after a network timeout. A changed request under the same key returns 409.

Coverage notes

Returns searchable alumni matching the specified school name or ID.

See coverage and limits before planning a production dependency. For async execution, replace /run/live with /run/async using the same input.