LinkedIn Data API – Documentation

A reliable, professional LinkedIn data layer for real workflows.

This documentation repository covers the response schemas, field availability, and practical usage patterns for a LinkedIn data API designed for:

• Lead enrichment – enrich prospect data with professional context
• Recruiting & sourcing – find and evaluate candidates at scale
• Sales intelligence – research accounts, decision-makers, and buying signals
• Market research – analyze companies, industries, and professional networks

Note: This repo contains field-level documentation only. The API implementation and TypeScript types live in separate repositories.

---

Quick Start

New to the API? Start here:

1. Getting Started Guide – understand the API, authentication, and rate limits
2. Use Case Guides – jump straight to your workflow (lead enrichment, recruiting, etc.)
3. Endpoint Reference – detailed field docs for each endpoint

Just need field details? Jump to the Endpoint Index below.

---

Use Case Guides

These guides show how to combine endpoints to solve real problems:

• Lead Enrichment – enrich CRM records with LinkedIn profile data
• Recruiting & Sourcing – find candidates, extract work history, verify credentials
• Sales Intelligence – research accounts, map org charts, identify decision-makers
• Market Research – analyze industries, track competitor hiring, monitor professional trends

Each guide includes:

• Which endpoints to use
• Required vs optional fields
• Example request flows
• Common integration patterns

---

Endpoint Index

Profiles & People

• profile.md – core profile information (name, headline, location, network stats)
• profile-enrichment.md – detailed work history, education, certifications, skills
• profile-activity.md – posts, shares, and engagement activity
• profile-interests.md – followed companies, influencers, topics
• profile-relationships.md – connections, mutual connections, relationship signals

Companies & Organizations

• company.md – company profiles, employee counts, industry classification, funding
• group.md – LinkedIn groups (membership, activity)

Jobs

• job.md – job postings, application details, hiring signals

Content & Ads

• post.md – post content, comments, reactions, media
• ad-library.md – ad library entities (experimental)

Search

• search.md – search people, companies, jobs, posts, and more
• search-metadata.md – location, industry, and filter metadata for search

---

How to Use These Docs

For Integration Work

1. Start with a use case guide to understand the workflow
2. Review the relevant endpoint docs to see field structures
3. Check the Example Responses section in each endpoint doc
4. Use the Best Practices section to handle edge cases (missing fields, privacy settings, etc.)

For Type Definitions

If you're building client libraries or DTOs:

1. Open the endpoint doc (e.g., profile.md)
2. Review the Response Schema section for TypeScript-style type definitions
3. Pay attention to fields marked as Core (always present) vs Optional/Nullable
4. Use the Field Descriptions section to understand semantics and edge cases

For Quality Assurance

When validating API responses:

1. Compare actual responses to the Example Responses in each doc
2. Check that Core Fields are always present
3. Verify optional fields are handled gracefully when null/missing
4. Report discrepancies by opening an Issue with a redacted response sample

---

Field Availability & Privacy

LinkedIn profiles vary widely in completeness and visibility:

• Core fields (name, headline, profile URL) are almost always present
• Contact info (email, phone) is usually private
• Work history depends on what users have added and made public
• Network data (connections, followers) may be obfuscated for privacy

Always treat fields not marked as "Core" as optional in your code.

See the Privacy-Dependent Fields section in each endpoint doc for details.

---

API Coverage

This documentation covers:

• ✅ Profile data (basic + enrichment)
• ✅ Company profiles
• ✅ Job postings
• ✅ Search (people, companies, jobs, posts, etc.)
• ✅ Post content & engagement
• ⚠️ Ad library (experimental, limited coverage)
• ⚠️ Groups (experimental)

For features not covered here, check the main API documentation or contact support.

---

Keeping Docs in Sync

These docs are maintained alongside the production API. When the API changes:

• New/removed fields are documented in the relevant docs/*.md file
• Example payloads are updated to match real responses
• Breaking changes are noted in the endpoint doc

Found a mismatch? Open an Issue with:

• The endpoint you called
• A redacted example response
• A note about what differs from the docs

This helps keep field-level documentation accurate for everyone.

---

Contributing

Improvements, clarifications, and corrections are welcome. Please:

1. Open an Issue to discuss significant changes
2. Keep additions aligned with existing doc structure
3. Include example payloads for new fields
4. Maintain clarity for developers (avoid marketing language)

---

License

This documentation is provided as-is for use with the LinkedIn Data API.