Поделиться через

Events

  • Статья

Warning

Deprecation Notice
The Marketing Version 202402 (Marketing February 2024) has been sunset. 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 an organization’s events. Restricted to organizations where the authenticated member has one of the following company page roles.
  • ADMINISTRATOR
  • CONTENT_ADMINISTRATOR
Permission Description
r_events_leadgen_automation Retrieve an organization’s events. Restricted to organizations where the authenticated member has one of the following company page roles.
  • ADMINISTRATOR
  • CONTENT_ADMINISTRATOR
Permission Description
r_events Retrieve an organization’s events. Restricted to organizations where the authenticated member holds one of the following company page roles:
  • ADMINISTRATOR
  • CONTENT_ADMINISTRATOR
rw_events Modify an organization's events. This is restricted to organizations where the authenticated member holds 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

Events

Field Type Description
id Long Identifier of the event.
name MultiLocaleString Name of the event as provided 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 where the event is taking place. This field will not be present when address is not provided by the organizer.
timeRangeV2.startsAt Long Start time of the event.
timeRangeV2.endsAt Long End time of the event. The field will not be present if the organizer has not 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 as provided 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 generation 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.

EventSetting

Field Type Description
entryCriteria EventEntryCriteria Member must satisfy the entry criteria 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 with no physical location associated with it and can only be attended virtually using a streaming URL
  • IN_PERSON_OR_VIRTUAL: The event has a physical location for in-person attendance and also provides a URL for virtual attendance.
additionalEntryCriteria AdditionalEventEntryCriteria Entry criteria, in addition to those specified in the entryCriteria field, that a member must satisfy to attend the event.

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 provided by the creator.
description MultiLocaleRichText Description of the event as provided 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 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 generation form for the event.
leadGenForm VersionedLeadGenFormUrn The lead generation form attached to the event.
discoveryMode EventDiscoveryMode Modes in which an event can be discovered on LinkedIn.
ugcPost UserGeneratedContentPostUrn URN of the post associated with this event. This field is automatically set upon posting the event.

Events

Field Type Description
id Long Unique Identifier of the event.
name MultiLocaleString Name of the event as provided by the creator.
description MultiLocaleRichText Description of the event as provided by the creator. This field will not be present if the 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. 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 search engine optimization.
startsAt Long Start time of the event in epoch millis.
backgroundImage DigitalmediaAssetUrn Background image used in displaying the event. If undefined, the default background image is used.
leadGenFormSpec LeadGenFormSpec Specifies how to generate a lead generation form for the event.
leadGenForm VersionedLeadGenFormUrn Lead generation form attached to the event.
discoveryMode EventDiscoveryMode Modes in which an event can be discovered on LinkedIn.
ugcPost UserGeneratedContentPostUrn 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 Indicates whether the event is streamed on LinkedIn, streamed from an external website, or broadcast 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 The URN for the broadcast entity of an interactive meeting or live audio event. Returned only in CREATE responses.
LiveVideo

This schema represents a 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 provides 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 URL of a page external to LinkedIn that contains information on the event.
venueDetails MultiLocaleRichText Additional details about the event venue.

LeadGenFormSpec

A union that specifies how to attach a lead generation form to an event during its creation. The following table provides the union's possible values:

Member Type Description
privacyPolicyUrl URL Attaches a lead generation form, generated from a pre-defined template, to the event.
leadGenForm VersionedLeadGenFormUrn Attaches the pre-existing lead generation form to the event. This lead generation form must already be approved.

Operations

Create an Event

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. Creating an event can be a one-step or three-step process, depending on whether a custom background image is included during setup. Optionally, you can create a background image asset. Refer to this section for more information.

  • If a custom background image is not provided during event setup, follow the three-step process outlined below.

    1. Register an upload.
    2. Upload a background image. Refer to the upload section.
    3. Create an event.

  • If a custom background image is provided during event setup, you can directly create an event.

Create Background Image Asset

Following is an example of the two-step process for creating a background image asset:

  1. Register an upload.
  2. Upload an image.
Register Upload

The asset property in the response is a URN that uniquely identifies the background image uploaded in the subsequent step.

Sample Request
POST https://api.linkedin.com/rest/assets?action=registerUpload

{
    "registerUploadRequest": {
        "owner": "urn:li:organization:7185861",
        "recipes": [
            "urn:li:digitalmediaRecipe:feedshare-image"
        ],
        "serviceRelationships": [
            {
                "identifier": "urn:li:userGeneratedContent",
                "relationshipType": "OWNER"
            }
        ],
        "supportedUploadMechanism": [
            "SYNCHRONOUS_UPLOAD"
        ]
    }
}
Sample Response

HTTP/1.1 200 OK

{
    "value": {
        "mediaArtifact": "urn:li:digitalmediaMediaArtifact:(urn:li:digitalmediaAsset:D5522AQEFM6ArFzip2Q,urn:li:digitalmediaMediaArtifactClass:uploaded-image)",
        "uploadMechanism": {
            "com.linkedin.digitalmedia.uploading.MediaUploadHttpRequest": {
                "uploadUrl": "https://api.linkedin-ei.com/mediaUpload/sp/sync/D5522AQEFM6ArFzip2Q/uploaded-image/0?ca=vector_feedshare&cn=uploads&m=AQLJddCQmalNqwAAAZJyuIrtiqodKbVmtsUecAh5N02nWs9_GV6VcNVG6Q&app=11700002&sync=1&v=beta&ut=0gpoRJPpiDBbs1",
                "headers": {
                    "media-type-family": "STILLIMAGE"
                }
            }
        },
        "asset": "urn:li:digitalmediaAsset:D5522AQEFM6ArFzip2Q",
        "assetRealTimeTopic": "urn:li-realtime:digitalmediaAssetUpdatesTopic:urn:li:digitalmediaAsset:D5522AQEFM6ArFzip2Q"
    }
}
Upload

Use the uploadUrl from the response of the previous step to upload a background image.

Sample Request
POST https://api.linkedin.com/mediaUpload/sp/sync/D5522AQEFM6ArFzip2Q/uploaded-image/0?ca=vector_feedshare&cn=uploads&m=AQLJddCQmalNqwAAAZJyuIrtiqodKbVmtsUecAh5N02nWs9_GV6VcNVG6Q&app=11700002&sync=1&v=beta&ut=0gpoRJPpiDBbs1
Sample Response

HTTP/1.1 201 Created

Create Event

Following are the examples of creating various types of events:

Live Video Event Example

A live video event is an event that one streams on LinkedIn.

Sample Request
POST https:///api.linkedin.com/rest/events

{
    "name": {
        "localized": {
            "en_US": "test online event"
        }
    },
    "type": {
        "online": {
            "format": {
                "liveVideo": {
                    "endsAt": 9091536065000
                }
            }
        }
    },
    "organizer": "urn:li:organization:7185861",
    "leadGenFormSpec": {
        "privacyPolicyUrl": "https://kneelbeforezod.com"
    },
    "startsAt": 9091536064111
    "backgroundImage": "urn:li:digitalmediaAsset:D5522AQEFM6ArFzip2Q"
}
Sample Response

HTTP/1.1 201 Created

{
    "vanityName": "testonlineevent7249811611689828352",
    "discoveryMode": "LISTED",
    "leadGenForm": "urn:li:versionedLeadGenForm:(urn:li:leadGenForm:7249811611534639104,1)",
    "created": {
        "actor": "urn:li:person:vU6QAVEtcr",
        "time": 1728489783272
    },
    "organizer": "urn:li:organization:7185861",
    "name": {
        "localized": {
            "en_US": "test online event"
        }
    },
    "startsAt": 9091536064111,
    "id": 7249811611689828352,
    "lastModified": {
        "actor": "urn:li:person:vU6QAVEtcr",
        "time": 1728489783272
    },
    "type": {
        "online": {
            "format": {
                "liveVideo": {
                    "endsAt": 9091536065000,
                    "liveVideo": "urn:li:liveVideo:7249811612692275200"
                }
            }
        }
    },
    "backgroundImage": "urn:li:digitalmediaAsset:D5522AQEFM6ArFzip2Q"
}
Live Audio Event Example

A live audio event is an audio-only event that one streams on LinkedIn.

Sample Request
POST https:///api.linkedin.com/rest/events

{
    "name": {
        "localized": {
            "en_US": "test online event"
        }
    },
    "type": {
        "online": {
            "format": {
                "liveAudio": {
                    "endsAt": 9091536065000
                }
            }
        }
    },
    "organizer": "urn:li:organization:7185861",
    "leadGenFormSpec": {
        "privacyPolicyUrl": "https://kneelbeforezod.com"
    },
    "startsAt": 9091536064111
    "backgroundImage": "urn:li:digitalmediaAsset:D5522AQEFM6ArFzip2Q"
}
Sample Response

HTTP/1.1 201 Created

{
    "vanityName": "testonlineevent7249811887951855616",
    "discoveryMode": "LISTED",
    "leadGenForm": "urn:li:versionedLeadGenForm:(urn:li:leadGenForm:7249811887599542272,1)",
    "created": {
        "actor": "urn:li:person:vU6QAVEtcr",
        "time": 1728489849889
    },
    "organizer": "urn:li:organization:7185861",
    "name": {
        "localized": {
            "en_US": "test online event"
        }
    },
    "startsAt": 9091536064111,
    "id": 7249811887951855616,
    "lastModified": {
        "actor": "urn:li:person:vU6QAVEtcr",
        "time": 1728489849889
    },
    "type": {
        "online": {
            "format": {
                "liveAudio": {
                    "endsAt": 9091536065000,
                    "room": "urn:li:room:7249811890279702528"
                }
            }
        }
    },
    "backgroundImage": "urn:li:digitalmediaAsset:D5522AQEFM6ArFzip2Q"
}
External Event Example

An external event is an event hosted on a site other than LinkedIn.

Sample Request
POST https:///api.linkedin.com/rest/events

{
    "name": {
        "localized": {
            "en_US": "test online event"
        }
    },
    "type": {
        "online": {
            "format": {
                "external": {
                    "endsAt": 9091536065000,
                    "url": "https://cometomesonofjorel.com"
                }
            }
        }
    },
    "organizer": "urn:li:organization:7185861",
    "leadGenFormSpec": {
        "privacyPolicyUrl": "https://kneelbeforezod.com"
    },
    "startsAt": 9091536064111
    "backgroundImage": "urn:li:digitalmediaAsset:D5522AQEFM6ArFzip2Q"
}
Sample Response

HTTP/1.1 201 Created

{
    "vanityName": "testonlineevent7249812147952566272",
    "discoveryMode": "LISTED",
    "leadGenForm": "urn:li:versionedLeadGenForm:(urn:li:leadGenForm:7249812147889659904,1)",
    "created": {
        "actor": "urn:li:person:vU6QAVEtcr",
        "time": 1728489911114
    },
    "organizer": "urn:li:organization:7185861",
    "name": {
        "localized": {
            "en_US": "test online event"
        }
    },
    "startsAt": 9091536064111,
    "id": 7249812147952566272,
    "lastModified": {
        "actor": "urn:li:person:vU6QAVEtcr",
        "time": 1728489911114
    },
    "type": {
        "online": {
            "format": {
                "external": {
                    "endsAt": 9091536065000,
                    "url": "https://cometomesonofjorel.com"
                }
            }
        }
    },
    "backgroundImage": "urn:li:digitalmediaAsset:D5522AQEFM6ArFzip2Q"
}
In-person Event Example

An in-person event is an event held at a physical address.

Sample Request
POST https:///api.linkedin.com/rest/events

{
    "name": {
        "localized": {
            "en_US": "test online event"
        }
    },
    "type": {
        "inPerson": {
            "endsAt": 9091536065000,
            "url": "https://cometomesonofjorel.com",
            "address": { }
        }
    },
    "organizer": "urn:li:organization:7185861",
    "leadGenFormSpec": {
        "privacyPolicyUrl": "https://kneelbeforezod.com"
    },
    "startsAt": 9091536064111
    "backgroundImage": "urn:li:digitalmediaAsset:D5522AQEFM6ArFzip2Q"
}
Sample Response

HTTP/1.1 201 Created

{
    "vanityName": "testonlineevent7249812613549670400",
    "discoveryMode": "LISTED",
    "leadGenForm": "urn:li:versionedLeadGenForm:(urn:li:leadGenForm:7249812613490958336,1)",
    "created": {
        "actor": "urn:li:person:vU6QAVEtcr",
        "time": 1728490022117
    },
    "organizer": "urn:li:organization:7185861",
    "name": {
        "localized": {
            "en_US": "test online event"
        }
    },
    "startsAt": 9091536064111,
    "id": 7249812613549670400,
    "lastModified": {
        "actor": "urn:li:person:vU6QAVEtcr",
        "time": 1728490022117
    },
    "type": {
        "inPerson": {
            "address": {},
            "endsAt": 9091536065000,
            "url": "https://cometomesonofjorel.com"
        }
    },
    "backgroundImage": "urn:li:digitalmediaAsset:D5522AQEFM6ArFzip2Q"
}

Post an Event

In this step, a request is made to the Posts API to publish an event on LinkedIn. An event becomes readable and writeable only after it has been successfully posted.

Live Video Event Example

In this example one uses the value of the property type.online.format.liveVideo.liveVideo in the response to the creation of a live video event to post that event.

Sample Request
POST https://api.linkedin.com/rest/posts?actor=urn%3Ali%3Amember%3A253823536

{
    "author": {
        "company": "urn:li:company:7185861"
    },
    "postContent": {
        "commentary": {
            "attributes": [],
            "text": ""
        },
        "content": {
            "content": {
                "value": {
                    "com.linkedin.content.ReferenceContent": {
                        "content": "urn:li:liveVideo:7249811612692275200"
                    }
                }
            }
        }
    },
    "lifecycleState": {
        "com.linkedin.ugc.PublishedState": {

        }
    },
    "visibility": "PUBLIC",
    "origin": "FEED",
    "context": {
        "paidEndorsementContext": {
            "active": false
        }
    },
    "distribution": {
        "feedDistribution": "MAIN_FEED",
        "externalDistributionChannels": []
    }
}
Sample Response

HTTP/1.1 201 Created

Fetch an Event

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

An event is not fetchable until one posts that event.

Example

Sample Request

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

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

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

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

HTTP/1.1 200 Ok

{
    "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
    }
}

HTTP/1.1 200 Ok

{
    "vanityName": "kneelbeforezodyetagain",
    "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
                }
            }
        }
    }
}

Update an Event

An event cannot be updated until it has been posted.

Example

The vanity name of an event can be updated as shown in sample request below.

Sample Request

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

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

{
    "patch": {
        "$set": {
            "vanityName": "kneelbeforezodyetagain"
        }
    }
}
Sample Response

HTTP/1.1 200 Ok

Delete an Event

An event cannot be deleted until it is posted.

You can delete a posted event by deleting its associated post. See the Posts API documentation for more details.

Example

Sample Request

Note

The last component of the URL path is the URL-encoded URN of the post to be deleted.

DELETE https://api.linkedin.com/rest/posts/urn%3Ali%3AugcPost%3A7246780305028571136
Sample Response

HTTP/1.1 204 No Content

Find Events by Organizer

Query Parameters

Parameter Type Description Required Default Value
organizer PersonUrn or OrganizerUrn The organizer of each event that this endpoint yields is equal to this value. Yes
start Integer The index of the first event to return. No 0
count Integer The endpoint maximizes the number of events that it returns such that the number does not exceed this value. No 10
excludeCancelled Boolean If true, then the endpoint excludes cancelled events from the pool of candidates to return. No false
timeBasedFilter EventTimeBasedFilter Temporally restricts the pool of candidate events to return. No
entryCriteria EventEntryCriteria Restricts the candidate events to return to those only whose entry criteria matches this value. No
sortOrder EventSortOrder Specifies the order of the candidate events to return. No

Schemas

EventTimeBasedFilter

A union with the following definitions:

Key Type Description Sample Value
lifeCycleState EventLifeCycleState Enumerates the states of an event's life cycle: UPCOMING, ONGOING, or PAST {"lifeCycleState":"ONGOING"}
ongoingTimeRange ClosedTimeRange A closed interval of timestamps [start, end]. {"ongoingTimeRange":{"start":1, "end":2}}
startTimeRange TimeRange An open or semi-open interval of timestamps: (-∞, ∞), [start, ∞), or (-∞, end), or [start, end) {"startTimeRange":{"start":1, "end":2}}
EventEntryCriteria

An enumeration with the following possible values:

Value Description
PUBLIC Denotes a public event.
GATED Denotes a gated event.
EventSortOrder

An enumeration with the following possible values:

Value Description
START_TIME_ASC Sorts events in ascending order based on their start time.
END_TIME_DESC Sorts events in descending order based on their end time.

Example

Sample Request
GET https:///api.linkedin.com/rest/events?q=eventsByOrganizer&organizer=urn%3Ali%3Aorganization%3A7185861&start=0&count=10&excludeCancelled=true&timeBasedFilter=(lifeCycleState%3APAST)&entryCriteria=PUBLIC&sortOrder=END_TIME_DESC
Sample Response

HTTP/1.1 200 Ok

{
    "elements": [
        {
            "vanityName": "testliveevent7130245568970252288",
            "discoveryMode": "LISTED",
            "ugcPost": "urn:li:ugcPost:7044751230899736576",
            "created": {
                "actor": "urn:li:person:vU6QAVEtcr",
                "time": 1699983017337
            },
            "organizer": "urn:li:organization:7185861",
            "name": {
                "localized": {
                    "en_US": "test live event"
                },
                "preferredLocale": {
                    "country": "US",
                    "language": "en"
                }
            },
            "startsAt": 1708749167000,
            "id": 7130245568970252288,
            "lastModified": {
                "actor": "urn:li:person:vU6QAVEtcr",
                "time": 1699983017337
            },
            "type": {
                "online": {
                    "format": {
                        "liveVideo": {}
                    }
                }
            }
        },
        {
            "vanityName": "testliveevent7130245292590788608",
            "discoveryMode": "LISTED",
            "ugcPost": "urn:li:ugcPost:7044751230899736576",
            "created": {
                "actor": "urn:li:person:vU6QAVEtcr",
                "time": 1699982951398
            },
            "organizer": "urn:li:organization:7185861",
            "name": {
                "localized": {
                    "en_US": "test live event"
                },
                "preferredLocale": {
                    "country": "US",
                    "language": "en"
                }
            },
            "startsAt": 1708749167000,
            "id": 7130245292590788608,
            "lastModified": {
                "actor": "urn:li:person:vU6QAVEtcr",
                "time": 1699982951398
            },
            "type": {
                "online": {
                    "format": {
                        "liveVideo": {}
                    }
                }
            }
        },
        {
            "vanityName": "testliveevent7130245111300386816",
            "discoveryMode": "LISTED",
            "ugcPost": "urn:li:ugcPost:7044751230899736576",
            "created": {
                "actor": "urn:li:person:vU6QAVEtcr",
                "time": 1699982908195
            },
            "organizer": "urn:li:organization:7185861",
            "name": {
                "localized": {
                    "en_US": "test live event"
                },
                "preferredLocale": {
                    "country": "US",
                    "language": "en"
                }
            },
            "startsAt": 1708749167000,
            "id": 7130245111300386816,
            "lastModified": {
                "actor": "urn:li:person:vU6QAVEtcr",
                "time": 1699982908195
            },
            "type": {
                "online": {
                    "format": {
                        "liveVideo": {}
                    }
                }
            }
        },
        {
            "vanityName": "testliveevent7130085076381364224",
            "discoveryMode": "LISTED",
            "ugcPost": "urn:li:ugcPost:7044751230899736576",
            "created": {
                "actor": "urn:li:person:vU6QAVEtcr",
                "time": 1699944753112
            },
            "organizer": "urn:li:organization:7185861",
            "name": {
                "localized": {
                    "en_US": "test live event"
                },
                "preferredLocale": {
                    "country": "US",
                    "language": "en"
                }
            },
            "startsAt": 1708749167000,
            "id": 7130085076381364224,
            "lastModified": {
                "actor": "urn:li:person:vU6QAVEtcr",
                "time": 1699944753112
            },
            "type": {
                "online": {
                    "format": {
                        "liveVideo": {}
                    }
                }
            }
        },
        {
            "vanityName": "testliveevent7130084947838529536",
            "discoveryMode": "LISTED",
            "ugcPost": "urn:li:ugcPost:7044751230899736576",
            "created": {
                "actor": "urn:li:person:vU6QAVEtcr",
                "time": 1699944722223
            },
            "organizer": "urn:li:organization:7185861",
            "name": {
                "localized": {
                    "en_US": "test live event"
                },
                "preferredLocale": {
                    "country": "US",
                    "language": "en"
                }
            },
            "startsAt": 1708749167000,
            "id": 7130084947838529536,
            "lastModified": {
                "actor": "urn:li:person:vU6QAVEtcr",
                "time": 1699944722223
            },
            "type": {
                "online": {
                    "format": {
                        "liveVideo": {}
                    }
                }
            }
        },
        {
            "vanityName": "testliveevent7130084808772182016",
            "discoveryMode": "LISTED",
            "ugcPost": "urn:li:ugcPost:7044751230899736576",
            "created": {
                "actor": "urn:li:person:vU6QAVEtcr",
                "time": 1699944689146
            },
            "organizer": "urn:li:organization:7185861",
            "name": {
                "localized": {
                    "en_US": "test live event"
                },
                "preferredLocale": {
                    "country": "US",
                    "language": "en"
                }
            },
            "startsAt": 1708749167000,
            "id": 7130084808772182016,
            "lastModified": {
                "actor": "urn:li:person:vU6QAVEtcr",
                "time": 1699944689146
            },
            "type": {
                "online": {
                    "format": {
                        "liveVideo": {}
                    }
                }
            }
        },
        {
            "vanityName": "testliveevent7130084664915947520",
            "discoveryMode": "LISTED",
            "ugcPost": "urn:li:ugcPost:7044751230899736576",
            "created": {
                "actor": "urn:li:person:vU6QAVEtcr",
                "time": 1699944654766
            },
            "organizer": "urn:li:organization:7185861",
            "name": {
                "localized": {
                    "en_US": "test live event"
                },
                "preferredLocale": {
                    "country": "US",
                    "language": "en"
                }
            },
            "startsAt": 1708749167000,
            "id": 7130084664915947520,
            "lastModified": {
                "actor": "urn:li:person:vU6QAVEtcr",
                "time": 1699944654766
            },
            "type": {
                "online": {
                    "format": {
                        "liveVideo": {}
                    }
                }
            }
        },
        {
            "vanityName": "testliveevent7130084640249241600",
            "discoveryMode": "LISTED",
            "ugcPost": "urn:li:ugcPost:7044751230899736576",
            "created": {
                "actor": "urn:li:person:vU6QAVEtcr",
                "time": 1699944648888
            },
            "organizer": "urn:li:organization:7185861",
            "name": {
                "localized": {
                    "en_US": "test live event"
                },
                "preferredLocale": {
                    "country": "US",
                    "language": "en"
                }
            },
            "startsAt": 1708749167000,
            "id": 7130084640249241600,
            "lastModified": {
                "actor": "urn:li:person:vU6QAVEtcr",
                "time": 1699944648888
            },
            "type": {
                "online": {
                    "format": {
                        "liveVideo": {}
                    }
                }
            }
        },
        {
            "vanityName": "testliveevent7130084608682909696",
            "discoveryMode": "LISTED",
            "ugcPost": "urn:li:ugcPost:7044751230899736576",
            "created": {
                "actor": "urn:li:person:vU6QAVEtcr",
                "time": 1699944641362
            },
            "organizer": "urn:li:organization:7185861",
            "name": {
                "localized": {
                    "en_US": "test live event"
                },
                "preferredLocale": {
                    "country": "US",
                    "language": "en"
                }
            },
            "startsAt": 1708749167000,
            "id": 7130084608682909696,
            "lastModified": {
                "actor": "urn:li:person:vU6QAVEtcr",
                "time": 1699944641362
            },
            "type": {
                "online": {
                    "format": {
                        "liveVideo": {}
                    }
                }
            }
        },
        {
            "vanityName": "testliveevent7130084539053268992",
            "discoveryMode": "LISTED",
            "ugcPost": "urn:li:ugcPost:7044751230899736576",
            "created": {
                "actor": "urn:li:person:vU6QAVEtcr",
                "time": 1699944624911
            },
            "organizer": "urn:li:organization:7185861",
            "name": {
                "localized": {
                    "en_US": "test live event"
                },
                "preferredLocale": {
                    "country": "US",
                    "language": "en"
                }
            },
            "startsAt": 1708749167000,
            "id": 7130084539053268992,
            "lastModified": {
                "actor": "urn:li:person:vU6QAVEtcr",
                "time": 1699944624911
            },
            "type": {
                "online": {
                    "format": {
                        "liveVideo": {}
                    }
                }
            }
        }
    ],
    "paging": {
        "count": 10,
        "start": 0,
        "total": 0,
        "links": [
            {
                "rel": "next",
                "type": "application/json",
                "href": "/events?q=eventsByOrganizer&timeBasedFilter=(lifeCycleState:PAST)&organizer=urn%3Ali%3Aorganization%3A7185861&sortOrder=END_TIME_DESC&start=10&count=10&entryCriteria=PUBLIC&excludeCancelled=true"
            }
        ]
    }
}

Find Events with Lead Gen Form by Organizer

This endpoint returns all the lead generation form enabled events organized by a particular organization. This endpoint requires q=organizerLeadGenFormEnabledEvents and 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
GET https://api.linkedin.com/v2/events?organizer=urn%3Ali%3Aorganization%3A30109887&q=organizerLeadGenFormEnabledEvents&start=0&count=2

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

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

HTTP/1.1 200 Ok

{
    "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
    },
}

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"
      }
    ]
  }
}