Groups Fields

The following sections describe the output fields for the Groups domain model.

Group Output Fields

Parameter Definition
id Default. The group ID. Read-only. The ID is assigned automatically when the group is created.
name Default. The name of the group.
short-description A short description for the group.
description A full description for the group.
relation-to-viewer:(membership-state) The group's relationship to the user. Valid values are:                   
  • blocked
  • non-member
  • awaiting-confirmation
  • awaiting-parent-group-confirmation
  • member
  • moderator
  • manager
  • owner
relation-to-viewer:(available-actions) Valid values are:                
  • Add-post
  • Leave
  • View-posts
posts The accessing person must be a member of the group or the group must be open.

Note:If the accessing person is not a member of the group, archived posts are not returned.

counts-by-category Specifies the number of posts created in the past day for each category. This includes one CategoryCount for each category enabled for the group.
is-open-to-non-members Specifies whether the group discussions are open to non-members. Valid values are true and false.
category Valid values are:                   
  • alumni
  • corporate
  • conference
  • network
  • philanthropic
  • professional
  • other
website-url The external website for the group.
site-group-url LinkedIn site URL for the group.
locale Language locale of the group
location:(country) Country
location:(postal-code) Postal code of the group
allow-member-invites If true, members are allowed to invite other members to join. Valid values are true and false.
small-logo-url Small logo for the group, to be used when representing the group on other sites.
large-logo-url Large logo for the group, to be used when representing the group on other sites.
num-members Number of members of this group.

Post Output Fields

Parameter Definition
id Default. The post ID.
type The type of post. Valid values are:                  
  • standard
  • news
category The category of the post. Valid values are:                  
  • discussion
creator The member who created the post. See
Profile Fieldsto view the person fields available.
title The title of the post.
summary The post's summary.
creation-timestamp The timestamp for when the post was created.
relation-to-viewer:(is-following) Indicates if the user is following the poster. Valid values are true and false.
relation-to-viewer:(is-liked) Indicates if the user liked the post. Valid values are true and false.
relation-to-viewer:(available-actions) Valid values are:  
  • add-comment
  • flag-as-inappropriate
  • categorize-as-job
  • categorize-as-promotion
  • follow
  • like
  • reply-privately
likes Likes for the post. Ordered by liking person's distance from accessing person.
comments Comments on the post. The commenting person must be a member of the group or the group must be open, and the post cannot have been archived.
attachment An attachment to the post. Currently, this attachment is only available for GET operations. In addition, a URL embedded in the summary field of a post will not be used to scrape elements for attachments. This means that this element will only appear for posts that were created from the LinkedIn web site.
site-group-post-url LinkedIn site URL to the post.

Comment Output Fields

Parameter Definition
id Default. The comment ID.
text The comment text. Character limit?
creator The name of the person who created the comment. See
Profile Fieldsto view the person fields available.
creation-timestamp The timestamp for when the comment was created.
relation-to-viewer:(available-actions) Valid values are:                    
  • flag-as-inappropriate
  • delete

Group Membership Output Fields

Parameter Definition
person Default. The name of the member.
group:(id) Default. The ID for the group.
group:(name) Default. The name of the group.
membership-state The state of the person's membership. Valid values are:                  
  • blocked
  • non-member
  • awaiting-confirmation
  • awaiting-parent-group-confirmation
  • member
  • moderator
  • manager
  • owner
show-group-logo-in-profile Specifies whether or not to show the group logo in the member's profile. Valid values are true and false.
allow-messages-from-members Indicates if the member allows email contact from non-members. Valid values are true and false.
email-digest-frequency Indicates the frequency at which the member receives group emails. Valid values are:  
  • none
  • daily
  • weekly
email-announcements-from-managers Indicates if the member allows email messages from group managers. Valid values are true and false.
email-for-every-new-post Indicates if the member wants to receive an email message for each new post. Valid values are true and false.
posts Returns the posts sent by the member. Requires
rolefilter.