LinkedIn API

https://learn.microsoft.com/en-us/linkedin
Admin
LinkedIn's home for API documentation, covering Consumer, Compliance, Learning, Marketing, Sales,...
Tokens:671,707
Snippets:3,785
Trust Score:10
Update:19 hours ago
Show doc for...
Tokens:
Raw
### Sample Response for get

Source: https://learn.microsoft.com/en-us/linkedin/sales/api-reference/r_sales_nav_profiles/sales-navigator-profile-associations

Example JSON response for the get method, containing profilePhoto, profile, and member fields.

```json
{
  "profilePhoto": "bar",
  "profile": "foo",
  "member": "urn:li:person:bar"
}
```

--------------------------------

### Sample Response for Get Campaign

Source: https://learn.microsoft.com/en-us/linkedin/marketing/integrations/ads/account-structure/create-and-manage-campaigns?view=li-lms-2026-10

Example JSON response returned by the GET campaign endpoint, showing campaign fields such as account, status, targeting, and budget.

```json
{
    "account": "urn:li:sponsoredAccount:506289162",
    "associatedEntity": "urn:li:organization:2414183",
    "audienceExpansionEnabled": false,
    "campaignGroup": "urn:li:sponsoredCampaignGroup:602277684",
    "changeAuditStamps": {
        "created": {
            "time": 1530119777000
        },
        "lastModified": {
            "time": 1530119777000
        }
    },
    "costType": "CPC",
    "connectedTelevisionOnly": false,
    "creativeSelection": "OPTIMIZED",
    "dailyBudget": {
        "amount": "1800",
        "currencyCode": "USD"
    },
    "id": 141049524,
    "locale": {
        "country": "US",
        "language": "en"
    },
    "name": "Campaign Sponsored update B",
    "offsiteDeliveryEnabled": false,
    "optimizationPreference": {
        "frequencyOptimizationPreference": {
            "timeSpan": {
                "duration": 7,
                "unit": "DAY"
            },
            "optimizationType": "MAX_FREQUENCY",
            "frequency": 10
        }
    },
    "optimizationTargetType": "NONE",
    "test": false,
    "runSchedule": {
        "end": 9876543210123,
        "start": 1234567890987
    },
    "servingStatuses": [
        "ACCOUNT_SERVING_HOLD"
    ],
    "status": "ACTIVE",
    "targeting": {
        "includedTargetingFacets": {
            "employers": [
                "urn:li:organization:0000"
            ],
            "interfaceLocales": [
                {
                    "country": "US",
                    "language": "en"
                }
            ],
            "locations": [
                "urn:li:geo:103644278"
            ]
        }
    },
    "targetingCriteria": {
        "include": {
            "and": [
                {
                    "or": {
                        "urn:li:adTargetingFacet:employers": [
                            "urn:li:company:0000"
                        ]
                    }
                },
                {
                    "or": {
                        "urn:li:adTargetingFacet:locations": [
                            "urn:li:geo:103644278"
                        ]
                    }
                },
                {
                    "or": {
                        "urn:li:adTargetingFacet:interfaceLocales": [
                            "urn:li:locale:en_US"
                        ]
                    }
                }
            ]
        }
    },
    "type": "SPONSORED_UPDATES",
    "unitCost": {
        "amount": "15",
        "currencyCode": "USD"
    },
    "version": {
        "versionTag": "1"
    }
}
```

--------------------------------

### UGC Posts API request without authors parameter

Source: https://learn.microsoft.com/en-us/linkedin/compliance/release-notes

Example GET request to the UGC Posts API without the 'authors' parameter, which will be required starting October 8, 2018.

```HTTP
GET

https://api.linkedin.com/v2/ugcPosts?q=authors
```

--------------------------------

### Install dependencies with Maven

Source: https://learn.microsoft.com/en-us/linkedin/shared/authentication/sample-applications

Run 'mvn install' to install dependencies for the server or client.

```bash
mvn install
```

--------------------------------

### curl GET request to retrieve comments on a comment (duplicate example)

Source: https://learn.microsoft.com/en-us/linkedin/marketing/community-management/shares/network-update-social-actions?view=li-lms-2026-10

This is a duplicate of the earlier curl GET request example, shown again under 'Sample Request Example'. Note it includes an extra Linkedin-Version header.

```bash
curl -X GET 'https://api.linkedin.com/rest/socialActions/urn:li:comment:(urn:li:activity:6273189577469632512,6275822846992351232)/comments' \ 
-H 'Authorization: Bearer {INSERT_TOKEN}' \
-H 'Linkedin-Version: {version number in the format YYYYMM}' \
-H ‘X-Restli-Protocol-Version : 2.0.0’ \
-H 'Linkedin-Version: {version number in the format YYYYMM}'
```

--------------------------------

### HTTP GET request example with organization ID 89758488

Source: https://learn.microsoft.com/en-us/linkedin/marketing/community-management/organizations/organization-lookup-api?view=li-lms-2026-10

Example HTTP GET request using a specific organization ID (89758488) to retrieve organization details.

```http
GET https://api.linkedin.com/rest/organization/89758488
```

--------------------------------

### Configure client application.properties

Source: https://learn.microsoft.com/en-us/linkedin/shared/authentication/sample-applications

Set the server.port and SERVER_URL in the client's application.properties file.

```properties
server.port = <replace_with_required_port_no>
SERVER_URL = <replace_with_required_server_url>
```

--------------------------------

### HTTP GET request example with specific organization ID

Source: https://learn.microsoft.com/en-us/linkedin/marketing/community-management/organizations/organization-lookup-api?view=li-lms-2026-10

Example HTTP GET request using a specific organization ID (79988552) to retrieve organization details.

```http
GET https://api.linkedin.com/rest/organizations/79988552
```

--------------------------------

### Example SFTP get command to verify upload

Source: https://learn.microsoft.com/en-us/linkedin/learning/learning-experience-platform/lxp-docs/lxp-sftp

This command fetches a file from the SFTP server to verify it was uploaded correctly. It downloads content.csv to the local ./download directory.

```bash
sftp -i ~/.ssh/test_private_key -P 2705 testuser@sftp.linkedin.com
Connected to sftp.linkedin.com.
sftp> get content.csv /li-lls-lxp-thirdparty-12345/snapshot/1612565824000/content.csv ./download/content.csv
```

--------------------------------

### Batch Get Non-Administered Organizations - HTTP Request Example

Source: https://learn.microsoft.com/en-us/linkedin/marketing/community-management/organizations/organization-lookup-api?view=li-lms-2026-10

Example HTTP GET request using specific organization IDs (90966477, 79988552) to fetch non-administered organizations.

```http
GET https://api.linkedin.com/rest/organizationsLookup?ids=List(90966477,79988552)
```

--------------------------------

### Example 2: Redirect URI With State

Source: https://learn.microsoft.com/en-us/linkedin/consumer/integrations/verified-on-linkedin/guides/verification-url

Demonstrates the original redirect parameter with a state parameter, its URL-encoded form, and the final verification URL. The state parameter is preserved and passed through.

```text
&redirectUri=https://www.example.com/redirect?state=abc123
```

```text
%26redirectUri%3Dhttps%3A%2F%2Fwww.example.com%2Fredirect%3Fstate%3Dabc123
```

```text
https://www.linkedin.com/trust/verification?isDeeplinkToCCT=true&verificationUrl=https%3A%2F%2Fwww.linkedin.com%2Fverify%3FentryPoint%3Dfederation_external_api%26partnerId%3D...%26redirectUri%3Dhttps%3A%2F%2Fwww.example.com%2Fredirect%3Fstate%3Dabc123
```

--------------------------------

### Configure server config.properties

Source: https://learn.microsoft.com/en-us/linkedin/shared/authentication/sample-applications

Set client credentials and redirect URI in the server's config.properties file.

```properties
clientId = <replace_with_client_id>
clientSecret = <replace_with_client_secret>
redirectUri = <replace_with_redirect_url_set_in_developer_portal>
scope = <replace_with_api_scope> 
client_url = <replace_with_client_url>
```

--------------------------------

### GET /geoTypeahead?q=federated&query=San

Source: https://learn.microsoft.com/en-us/linkedin/shared/references/v2/standardized-data/locations/geo-typeahead

Example GET request to the deprecated Geo Typeahead API. The query parameter is required. The second example includes an optional locale parameter with language and country sub-fields.

```http
GET https://api.linkedin.com/v2/geoTypeahead?q=federated&query=San

GET https://api.linkedin.com/v2/geoTypeahead?q=federated&query=San&locale=(language:en,country:US)
```

--------------------------------

### Sample Response for Creating a Like

Source: https://learn.microsoft.com/en-us/linkedin/marketing/community-management/shares/network-update-social-actions?view=li-lms-2026-10

The response includes the like URN, actor, agent, creation and modification timestamps, and the object URN. The time values are in milliseconds since epoch.

```json
{
    "id": "urn:li:like:(urn:li:person:0XV6h162Ub,urn:li:activity:6280442346165280768)",
    "actor": "urn:li:person:0XV6h162Ub",
    "agent": "urn:li:person:0XV6h162Ub",
    "created": {
        "actor": "urn:li:person:0XV6h162Ub",
        "time": 1497380688598
    },
    "lastModified": {
        "actor": "urn:li:person:0XV6h162Ub",
        "time": 1497380688598
    },
    "object": "urn:li:activity:6280442346165280768"
}
```

--------------------------------

### GET Geo Sample Response

Source: https://learn.microsoft.com/en-us/linkedin/shared/references/v2/standardized-data/locations/geo

Example JSON response for a GET request, showing the defaultLocalizedName and id fields.

```json
{
  "defaultLocalizedName":{
    "locale": {
      "country": "US",
      "language": "en"
    },
    "value": "San Francisco Bay Area"
  },
  "id": 104565322
```

--------------------------------

### Callback URL Example

Source: https://learn.microsoft.com/en-us/linkedin/consumer/integrations/verified-on-linkedin/guides/plus-tier/quickstart

Example of a callback URL with the state parameter, used to demonstrate how the state is passed through after verification.

```http
https://example.com/callback?state=abc123
```

--------------------------------

### Connect to SFTP server in PROD

Source: https://learn.microsoft.com/en-us/linkedin/learning/learning-experience-platform/lxp-docs/lxp-sftp

Use this command to connect to the SFTP server. Replace ~/.ssh/<my_private_key> with your private key and sftp_username with the username you created. The -P flag specifies port 2705.

```bash
sftp -i ~/.ssh/<my_private_key> -P 2705 <sftp_username>@sftp.linkedin.com
```

--------------------------------

### Sample response for GET seniority

Source: https://learn.microsoft.com/en-us/linkedin/shared/references/v2/standardized-data/seniorities

Example JSON response for a GET request, showing the seniority name, ID, and URN.

```json
{
    "name": {
        "localized": {
            "en_US": "Training"
        }
    },
    "id": 2,
    "$URN": "urn:li:seniority:2"
}
```

--------------------------------

### Run Spring Boot server

Source: https://learn.microsoft.com/en-us/linkedin/shared/authentication/sample-applications

Run 'mvn spring-boot:run' to start the Spring Boot server.

```bash
mvn spring-boot:run
```

--------------------------------

### Find Organization by Vanity Name - HTTP Request Example

Source: https://learn.microsoft.com/en-us/linkedin/marketing/community-management/organizations/organization-lookup-api?view=li-lms-2026-10

Example HTTP GET request using a specific vanityName (company-lgf-showcase).

```http
GET https://api.linkedin.com/rest/organization?q=vanityName&vanityName=company-lgf-showcase
```

--------------------------------

### Example SFTP upload commands for LMS data

Source: https://learn.microsoft.com/en-us/linkedin/learning/learning-experience-platform/lxp-docs/lxp-sftp

These commands show how to upload content.csv, progress.csv, and assignment.csv to the same timestamp directory. The timestamp must match for all files in a single upload.

```bash
sftp -i ~/.ssh/test_private_key -P 2705 testuser@sftp.linkedin.com
Connected to sftp.linkedin.com.
sftp> put content.csv /li-lls-lxp-lms-12345/snapshot/1612565824000/content.csv
sftp> put progress.csv /li-lls-lxp-lms-12345/snapshot/1612565824000/progress.csv
sftp> put assignment.csv /li-lls-lxp-lms-12345/snapshot/1612565824000/assignment.csv
```

--------------------------------

### GET fieldsOfStudy sample response

Source: https://learn.microsoft.com/en-us/linkedin/shared/references/v2/standardized-data/fields-of-study

Example JSON response for a GET request, showing the name, id, $URN, and rollupIds fields.

```JSON
{
    "name": {
        "localized": {
            "en_US": "Culinary Arts and Related Services"
        }
    },
    "id": 100220,
    "$URN": "urn:li:fieldOfStudy:100220",
    "rollupIds": [
        "urn:li:fieldOfStudy:100203"
    ]
}
```

--------------------------------

### Sample response for GET degree

Source: https://learn.microsoft.com/en-us/linkedin/shared/references/v2/standardized-data/degrees

Example JSON response from the GET endpoint, showing the degree name, aliases, ID, URN, and rollup.

```json
{
    "name": {
        "localized": {
            "en_US": "Bachelor of Architecture"
        }
    },
    "alias": [
        {
            "localized": {
                "en_US": "BArch"
            }
        },
        {
            "localized": {
                "en_US": "Bachelor of Architecture (B.Arch.)"
            }
        },
        {
            "localized": {
                "en_US": "Bachelor of Architecture (BArch)"
            }
        }
    ],
    "id": 258,
    "$URN": "urn:li:degree:258",
    "rollup": "urn:li:degree:200"
}
```
Tokens:
Raw