Group Definitions API

Note

Usage of this API is restricted to approved partners, subject to limitations via API agreement.

The Group Definitions API provides rich access to see the metadata of LinkedIn groups.

Group Definition Schema

Field Name	Format	Description
created	AuditStamp	An AuditStamp corresponding to the creation of this Group.
deleted	optional AuditStamp	An AuditStamp corresponding to the deletion of this Group.
description	LocaleString	The description of what this Group is about.
id	int	The id of this Group.
lastModified	AuditStamp	An AuditStamp corresponding to the last modification of this Group.
logoUrn	optional DigitalmediaAsset URN	DigitalMediaAssetUrn of the originally uploaded logo image. If empty, then there is no logo image for this Group.
rules	optional LocaleString	The rules of this Group. This is Member generated input. This can be thought of as the policy of the Group as defined by an admin. A null value means that an admin has not defined any rules for their Group.
title	LocaleString	The Group title.
type	enum string	The type of Group. Can be either: STANDARD - Indicates that the Group is a STANDARD type. UNLISTED - Indicated the Group is an UNLISTED type. An UNLISTED Group has 2 restrictions: Members can join if and only if an admin invites them & the group will not be surfaced in any search results.
vanityName	optional string	The name of the Group that will be used in URLs. This value is globally unique amongst all other groups and is URL safe. A null value indicates there is no vanityName and this group will not be locatable via a static URL.

Retrieving Group Definitions

You can retrieve one or more group information via group ID using the API requests below. You will get a 403 if you are blocked from a specific group.

GET

https://api.linkedin.com/v2/groupDefinitions/{group ID}

GET

https://api.linkedin.com/v2/groupDefinitions?ids=List({group ID1},{group ID2})

Note : In order to make sample calls above succeed, you need indicate X-RestLi-Protocol-Version:2.0.0 in the request header.

sample group response

{
    "created": {
        "actor": "urn:li:person:123ABC", 
        "time": 1451016805
    }, 
    "description": {
        "locale": {
            "country": "US  ", 
            "language": "en", 
            "variant": null
        }, 
        "value": "To discuss LinkedIn APIs!"
    }, 
    "id": 7025949, 
    "lastModified": {
        "actor": "urn:li:person:123ABC", 
        "time": 1452001682
    }, 
    "logoUrn": "urn:li:digitalmediaAsset:C4E07AQGzgQPFVWqo9w", 
    "rules": {
        "locale": {
            "country": "US  ", 
            "language": "en", 
            "variant": null
        }, 
        "value": "Refer to https://developer.linkedin.com/docs"
    }, 
    "title": {
        "locale": {
            "country": "US  ", 
            "language": "en", 
            "variant": null
        }, 
        "value": "My Awesome Developer Group"
    }, 
    "type": "UNLISTED"
}

Updating Group Definitions

As a group admin, you can edit your group's title , description , rules , logoUrn and type .

POST

https://api.linkedin.com/v2/groupDefinitions/{group ID}

request body

{
    "patch": {
        "$set": {
            "description": {
                "locale": {
                    "country": "US  ", 
                    "language": "en", 
                    "variant": null
                }, 
                "value": "Updating my group's description!"
            }
        }
    }
}

Deleting Group Definitions

As a group admin, you have the ability to delete your own group(s).

DELETE

https://api.linkedin.com/v2/groupDefinitions/{group ID}

Decoration of groupUrn and logoUrn

To decorate a groupUrn, you will need specify ~:groupDefinition . See below for an example:

GET

https://api.linkedin.com/v2/groupMemberships?q=member&membershipStatuses=MEMBER&member={person URN}&projection=(elements*(group~:groupDefinition))

To decorate a logoUrn, you will need specify ~:playableStreams . See the here for more information and below for an example:

GET

https://api.linkedin.com/v2/groupDefinitions/{ID}?projection=(logoUrn~:playableStreams)