Partager via

Events

  • Article

Warning

Deprecation Notice
The Marketing Version 202310 (Marketing October 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
Permission Description
r_events_leadgen_automation 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.

Events

Events Schema

Field Type Description
id Long Identifier of the event.
name MultiLocaleString The name of the event as inputted by the creator.
created.time Long Creation time.
created.actor PersonUrn Urn of the member who has created the event.
address Address The physical address of the event (i.e. where the event is taking place). This field will not be present when address is not provided by the organizer.
timeRangeV2.startsAt Long The start time of the event.
timeRangeV2.endsAt Long The end time of the event. The field will not be present if the organizer hasn't entered an end time during event creation/update
vanityName String Vanity name (unique across events) for the event that helps with easy identification and better SEO.
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.
settings EventSettings Container for various event settings.
versionedLeadGenForm VersionedLeadGenFormUrn VersionedLeadGenFormUrn of the lead gen form associated with the event. The versionedLeadGenForm field is nested in the settings field. See sample
lastModified.time Long Last modified time of the event.
lastModified.actor PersonUrn Urn of the member who has last modified the event.
Field Type Description
id Long Identifier of the event.
name MultiLocaleString The name of the event as inputted by the creator.
created.time Long Creation time.
created.actor PersonUrn Urn of the member who has created the event.
address Address The physical address of the event (i.e. where the event is taking place). This field will not be present when address is not provided by the organizer.
timeRangeV2.startsAt Long The start time of the event.
timeRangeV2.endsAt Long The end time of the event. The field will not be present if the organizer hasn't entered an end time during event creation/update
vanityName String Vanity name (unique across events) for the event that helps with easy identification and better SEO.
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.
settings EventSettings Container for various event settings.
versionedLeadGenForm VersionedLeadGenFormUrn VersionedLeadGenFormUrn of the lead gen form associated with the event. The versionedLeadGenForm field is nested in the settings field. See sample
ugcPost UserGeneratedContentPostUrn URN of the UserGeneratedContentPost that is associated with the event. This field will not be present for events with settings.mapsToSingleUgcPost=false.
lastModified.time Long Last modified time of the event.
lastModified.actor PersonUrn Urn of the member who has last modified the event.

EventSetting Schema

Field Type Description
entryCriteria EventEntryCriteria Entry criteria member needs to satisfy to be able to attend the event. Possible values:
  • PUBLIC: This event is open to all members.
  • GATED: A member needs to raise a request to attend the event.
invitationSettings EventInvitationSettings Invitation related settings for an event.
discoveryMode EventDiscoveryMode Mode in which the event can be discovered on LinkedIn. Possible values:
  • LISTED: Event is discoverable through search/relevance/recommendation channels.
  • URL_ONLY: Event can only be discovered via URL.
attendanceMode EventAttendanceMode Mode in which the attendees can attend an event. Possible values:
  • IN_PERSON: The event is an offline only event with physical location associated to it and can only be attended in person.
  • VIRTUAL: The event is an online only event, which has no physical location associated to it. It can only be attended virtually using steaming Url.
  • IN_PERSON_OR_VIRTUAL: The event has a physical location to attend in person and also has url for attending virtually.
additionalEntryCriteria AdditionalEventEntryCriteria Entry criteria, in addition to the one specified as part of field entryCriteria, that a member needs to satisfy to be able to attend the event.

Fetch Events by Organization

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.

Sample Request

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

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

Sample Response

{
    "elements": [
        {
            "settings": {
                "eventPostsVisibleToPublic": false,
                "attendanceMode": "IN_PERSON",
                "discoveryMode": "LISTED",
                "mapsToSingleUgcPost": false,
                "invitationSettings": {
                    "invitationPrivilegePolicies": [
                        {
                            "com.linkedin.eventsproduct.SimpleEventInvitationPrivilegePolicy": "ALL_ATTENDEES"
                        }
                    ]
                },
                "additionalEntryCriteria": {
                    "compositeCriteriaWithLogicalOr": [
                        {
                            "com.linkedin.eventsproduct.RegistrationThroughLeadGenFormV2": {
                                "versionedLeadGenForm": "urn:li:versionedLeadGenForm:(urn:li:leadGenForm:6788712107945934848,1)"
                            }
                        }
                    ],
                    "logicalOperatorForCombiningWithOtherEntryCriteria": "AND"
                },
                "entryCriteria": "PUBLIC"
            },
            "vanityName": "testlgfevent6788712108075945984",
            "localizedName": "Test LGF event",
            "address": {
                "geographicArea": "Karnataka",
                "country": "IN",
                "city": "Bengaluru",
                "line2": "Building 1, 5th Floor Marathahalli Outer Ring Road, Devarabeesanahalli, Varthur Hobli",
                "line1": "Rmz Ecoworld"
            },
            "organizer": "urn:li:organization:30109887",
            "created": {
                "actor": "urn:li:person:DIDLEqaiYz",
                "time": 1618555094891
            },
            "name": {
                "localized": {
                    "en_US": "Test LGF event"
                },
                "preferredLocale": {
                    "country": "US",
                    "language": "en"
                }
            },
            "description": {
                "localized": {
                    "en_US": {
                        "rawText": "test"
                    }
                },
                "preferredLocale": {
                    "country": "US",
                    "language": "en"
                }
            },
            "lastModified": {
                "actor": "urn:li:person:DIDLEqaiYz",
                "time": 1618555094891
            },
            "id": 6788712108075945984,
            "localizedDescription": {
                "rawText": "test"
            },
            "timeRangeV2": {
                "endsAt": 1647988200000,
                "startsAt": 1647984600000
            },
        },
        {
            "settings": {
                "eventPostsVisibleToPublic": false,
                "attendanceMode": "VIRTUAL",
                "discoveryMode": "LISTED",
                "mapsToSingleUgcPost": false,
                "invitationSettings": {
                    "invitationPrivilegePolicies": [
                        {
                            "com.linkedin.eventsproduct.SimpleEventInvitationPrivilegePolicy": "ALL_ATTENDEES"
                        }
                    ]
                },
                "additionalEntryCriteria": {
                    "compositeCriteriaWithLogicalOr": [
                        {
                            "com.linkedin.eventsproduct.RegistrationThroughLeadGenFormV2": {
                                "versionedLeadGenForm": "urn:li:versionedLeadGenForm:(urn:li:leadGenForm:6736766346387853312,1)"
                            }
                        }
                    ],
                    "logicalOperatorForCombiningWithOtherEntryCriteria": "AND"
                },
                "entryCriteria": "PUBLIC"
            },
            "localizedName": "LGF Test 2.0",
            "created": {
                "actor": "urn:li:person:51125319",
                "time": 1606170260364
            },
            "description": {
                "localized": {
                    "en_US": {
                        "rawText": "test p"
                    }
                },
                "preferredLocale": {
                    "country": "US",
                    "language": "en"
                }
            },
            "streamingUrl": "",
            "organizer": "urn:li:organization:30109887",
            "name": {
                "localized": {
                    "en_US": "LGF Test 2.0"
                },
                "preferredLocale": {
                    "country": "US",
                    "language": "en"
                }
            },
            "lastModified": {
                "actor": "urn:li:person:51125319",
                "time": 1606170260364
            },
            "id": 6736766346996002816,
            "localizedDescription": {
                "rawText": "test p"
            },
            "timeRangeV2": {
                "endsAt": 1647988200000,
                "startsAt": 1647984600000
            }
        }
    ],
    "paging": {
        "start": 0,
        "count": 2,
        "links": [],
        "total": 16
    },
}

Get Event

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

Sample Request

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

GET https://api.linkedin.com/v2/events/6768020385943339008

Sample Response

{
    "settings": {
        "eventPostsVisibleToPublic": false,
        "attendanceMode": "IN_PERSON",
        "discoveryMode": "LISTED",
        "mapsToSingleUgcPost": false,
        "invitationSettings": {
            "invitationPrivilegePolicies": [
                {
                    "com.linkedin.eventsproduct.SimpleEventInvitationPrivilegePolicy": "ALL_ATTENDEES"
                }
            ]
        },
        "additionalEntryCriteria": {
            "compositeCriteriaWithLogicalOr": [
                {
                    "com.linkedin.eventsproduct.RegistrationThroughLeadGenFormV2": {
                        "versionedLeadGenForm": "urn:li:versionedLeadGenForm:(urn:li:leadGenForm:6788712107945934848,1)"
                    }
                }
            ],
            "logicalOperatorForCombiningWithOtherEntryCriteria": "AND"
        },
        "entryCriteria": "PUBLIC"
    },
    "vanityName": "testlgfevent6788712108075945984",
    "localizedName": "Test LGF event",
    "address": {
        "geographicArea": "Karnataka",
        "country": "IN",
        "city": "Bengaluru",
        "line2": "Building 1, 5th Floor Marathahalli Outer Ring Road, Devarabeesanahalli, Varthur Hobli",
        "line1": "Rmz Ecoworld"
    },
    "organizer": "urn:li:organization:30109887",
    "created": {
        "actor": "urn:li:person:DIDLEqaiYz",
        "time": 1618555094891
    },
    "name": {
        "localized": {
            "en_US": "Test LGF event"
        },
        "preferredLocale": {
            "country": "US",
            "language": "en"
        }
    },
    "description": {
        "localized": {
            "en_US": {
                "rawText": "test"
            }
        },
        "preferredLocale": {
            "country": "US",
            "language": "en"
        }
    },
    "lastModified": {
        "actor": "urn:li:person:DIDLEqaiYz",
        "time": 1618555094891
    },
    "id": 6788712108075945984,
    "localizedDescription": {
        "rawText": "test"
    },
    "timeRangeV2": {
        "endsAt": 1647988200000,
        "startsAt": 1647984600000
    }
}