Events

Warning

Deprecation Notice
The Marketing Version 202311 (Marketing November 2023) and earlier versions (excluding 202306 and 202307) have been sunset. Additionally, the unversioned APIs will be sunset soon. We recommend that you migrate to the versioned APIs as well as migrate to the new Content and Community Management APIs to avoid disruptions. See the Migration page for more details. If you haven’t yet migrated and have questions, submit a request on the LinkedIn Developer Support Portal.

Events have been an important approach for companies to attract leads and make conversions. Event organizers leverage the events platform at LinkedIn to create event pages where members can register to attend events, join live stream online events, and participate in the post-event activities. At the same time, attendees discover relevant events, make new connections, and nurture existing relationships on the platform.

Permissions

Access to the LinkedIn Marketing API Program does not automatically grant access to the following APIs. Developers must apply separately to be considered for these APIs.

Permission	Description
r_events	Retrieve organization’s events. Restricted to organizations in which the authenticated member has one of the following company page roles. ADMINISTRATOR CONTENT_ADMINISTRATOR

See Organization Access Control for more information on company page roles.

Note

All API requests are represented in protocol 2.0.0 and require the header X-Restli-Protocol-Version: 2.0.0.

Schemas

A read-only field is immutable, and present only in responses to read requests. A create-only field is present only in create requests.

Events

Field	Type	Description
id	Long	Unique Identifier of the event.
name	MultiLocaleString	The name of the event as inputted by the creator.
description	MultiLocaleRichText	Description of the event inputted by the creator. This field will not be present when event description is not provided by the organizer.
type	OnlineEventType or InPersonEventType	Whether the event is online or in-person.
organizer	Urn	Entity responsible for organizing this event - Possible URN types: urn:li:person:abcd, urn:li:organization:1234. The validation for the entity type is done at the service level.
vanityName	String	Vanity name (unique across events) for the event that helps with easy identification and better SEO.
startsAt	Long	The start time of the event in epoch millis.
backgroundImage	DigitalmediaAssetUrn	The background image used in displaying the event. If undefined, the default background image is used.
leadGenFormSpec	Url	Specifies how to generate a lead gen form for the event.
leadGenForm	VersionedLeadGenFormUrn	The lead gen form attached to the event.
discoveryMode	EventDiscoveryMode	Modes in which an event can be discovered on LinkedIn.
ugcPost	UserGeneratedContentPostUrn	The URN of the post associated with this event. This field is automatically set upon posting the event.

OnlineEventType

This schema describes an event held virtually.

Field	Type	Description
format	LiveAudio, LiveVideo, or External	Whether the event is streamed on LinkedIn, streamed from an external website, or as live audio.

LiveAudio

This schema represents a live audio event hosted online.

Field	Type	Description
endsAt	Long	The end time of the event in epoch millis.
room	RoomUrn	URN for the broadcast entity of an interactive meeting or live audio event. Returned only in CREATE responses.

LiveVideo

This schema represents an live event streamed on Linkedin.

Field	Type	Description
endsAt	Long	The end time of the event in epoch millis.
liveVideo	LiveVideoUrn	The identifier of the live video that is automatically generated upon the creation of this event. Returned only in CREATE responses.

External

This schema represents an event streamed on an external website.

Field	Type	Description
endsAt	Long	The end time of the event in epoch millis.
url	Url	The URL of a page external to LinkedIn that contains information about the event.

InPersonEventType

This schema describes an event held at a physical location.

Field	Type	Description
endsAt	Long	The end time of the event in epoch millis.
address	Address	The address of the event's venue.
url	Url	The URL of a page external to LinkedIn that contains information on the event.
venueDetails	MultiLocaleRichText	The additional details about the event venue, on top of the address field.

Fetch an Event

Individual event can be requested using the endpoint below that only requires event identifier.

Example

Sample Request

The last component of the URL path is the ID of the event to fetch.

http

GET https://api.linkedin.com/rest/events/7246559654799892480

curl

curl -X GET 'https://api.linkedin.com/rest/events/7246559654799892480' \
-H 'X-RestLi-Protocol-Version: 2.0.0' \
-H 'Authorization: Bearer {INSERT_TOKEN}' \
-H 'LinkedIn-Version: {version number in the format YYYYMM}'

Sample Response

HTTP/1.1 200 Ok

{
    "vanityName": "testonlineevent7246559654799892480",
    "discoveryMode": "URL_ONLY",
    "ugcPost": "urn:li:ugcPost:7246780305028571136",
    "created": {
        "actor": "urn:li:person:vU6QAVEtcr",
        "time": 1727714456443
    },
    "organizer": "urn:li:organization:7185861",
    "name": {
        "localized": {
            "en_US": "test online event"
        }
    },
    "startsAt": 9091536064111,
    "id": 7246559654799892480,
    "lastModified": {
        "actor": "urn:li:person:vU6QAVEtcr",
        "time": 1728493578344
    },
    "type": {
        "online": {
            "format": {
                "liveVideo": {
                    "endsAt": 9091536065000
                }
            }
        }
    }
}

Find Events with Lead Gen Form by Organizer

This endpoint returns all the leadgen form enabled events organized by a particular organization. This endpoint requires q=organizerLeadGenFormEnabledEvents and a organization URN in the organizer parameter.

Since an organization can have a large volume of Events, this API supports pagination using the count and start parameters.

Parameter	Type	Description
q	String	You must always set this to organizerLeadGenFormEnabledEvents. It indicates that you're querying based on organizerLeadGenFormEnabledEvents.
organizer	OrganizationUrn	URN identifying the organizer of the event. This is the organization.
count	Integer	How many results to display on each page.
start	Integer	The index of the form to begin your result page at. Indexes start at 0. Default is 0.

Example

Sample Request

http

GET https://api.linkedin.com/rest/events?organizer=urn%3Ali%3Aorganization%3A7185861&start=0&count=2&q=organizerLeadGenFormEnabledEvents

curl

curl -X GET 'https://api.linkedin.com/rest/events?organizer=urn%3Ali%3Aorganization%3A7185861&start=0&count=2&q=organizerLeadGenFormEnabledEvents' \
-H 'X-RestLi-Protocol-Version: 2.0.0' \
-H 'Authorization: Bearer {INSERT_TOKEN}' \
-H 'LinkedIn-Version: {version number in the format YYYYMM}'

Sample Response

HTTP/1.1 200 Ok

{
  "elements": [
    {
      "vanityName": "testonlineevent7249811887951855616",
      "discoveryMode": "LISTED",
      "leadGenForm": "urn:li:versionedLeadGenForm:(urn:li:leadGenForm:7249811887599542272,1)",
      "ugcPost": "urn:li:ugcPost:7254257065492111360",
      "created": {
        "actor": "urn:li:person:vU6QAVEtcr",
        "time": 1728489849889
      },
      "organizer": "urn:li:organization:7185861",
      "name": {
        "localized": {
          "en_US": "test online event"
        }
      },
      "startsAt": 9091536064111,
      "id": 7249811887951856000,
      "lastModified": {
        "actor": "urn:li:person:yATEBawSE6",
        "time": 1729549663125
      },
      "type": {
        "online": {
          "format": {
            "liveAudio": {
              "endsAt": 9091536065000,
              "room": "urn:li:room:7249811890279702528"
            }
          }
        }
      }
    },
    {
      "vanityName": "testonlineevent7254255946724425728",
      "discoveryMode": "LISTED",
      "leadGenForm": "urn:li:versionedLeadGenForm:(urn:li:leadGenForm:7254255946464378880,1)",
      "ugcPost": "urn:li:ugcPost:7254256112596574208",
      "created": {
        "actor": "urn:li:person:vU6QAVEtcr",
        "time": 1729549395432
      },
      "organizer": "urn:li:organization:7185861",
      "name": {
        "localized": {
          "en_US": "test online event"
        }
      },
      "startsAt": 9091536064111,
      "id": 7254255946724426000,
      "lastModified": {
        "actor": "urn:li:person:vU6QAVEtcr",
        "time": 1729549395432
      },
      "type": {
        "online": {
          "format": {
            "liveVideo": {
              "endsAt": 9091536065000
            }
          }
        }
      }
    }
  ],
  "paging": {
    "count": 2,
    "start": 0,
    "total": 0,
    "links": [
      {
        "rel": "next",
        "type": "application/json",
        "href": "/events?organizer=urn%3Ali%3Aorganization%3A7185861&start=2&count=2&q=organizerLeadGenFormEnabledEvents"
      }
    ]
  }
}