Jump to

• Request
• Response

Get a list of all enabled groups.

get

/social/api/v1/groups

Request

Supported Media Types

• application/json

Body ()

Specify a filter to query.

Root Schema : XV1GroupFilterInfo

Type: object

V1 Group Filter Information.

Show Source

• groupTypes: array groupTypes
  Filter by group types.

{
    "description":"V1 Group Filter Information.",
    "properties":{
        "groupTypes":{
            "description":"Filter by group types.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/XV1GroupType"
            }
        }
    }
}

Nested Schema : groupTypes

Type: array

Filter by group types.

Show Source

• [0]: object XV1GroupType

{
    "description":"Filter by group types.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/XV1GroupType"
    }
}

Nested Schema : XV1GroupType

Type: object

Show Source

• field: string
  Allowed Values: [ "PRIVATE_CLOSED", "PUBLIC_CLOSED", "PUBLIC_OPEN" ]

  V1 group types.

{
    "properties":{
        "field":{
            "type":"string",
            "description":"V1 group types.",
            "enum":[
                "PRIVATE_CLOSED",
                "PUBLIC_CLOSED",
                "PUBLIC_OPEN"
            ]
        }
    }
}

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

V1 Group List Information DTO.

Root Schema : XV1GroupListInfo

Type: object

V1 Group List Information DTO.

Show Source

• hasMore: boolean
  If true, there are more items to be returned.
• items: array items
  The Groups being returned.
• nextURL: string(url)
  Next page URL for the list. Null if this is the last page.
• previousURL: string(url)
  Previous page URL for the list. Null if this is the first page.
• total: integer(int32)
  If specified, this is the total number of available items. Null if the total is unknown.

{
    "description":"V1 Group List Information DTO.",
    "properties":{
        "items":{
            "description":"The Groups being returned.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/XV1GroupInfo"
            }
        },
        "hasMore":{
            "description":"If true, there are more items to be returned.",
            "type":"boolean"
        },
        "nextURL":{
            "description":"Next page URL for the list. Null if this is the last page.",
            "type":"string",
            "format":"url"
        },
        "previousURL":{
            "description":"Previous page URL for the list. Null if this is the first page.",
            "type":"string",
            "format":"url"
        },
        "total":{
            "description":"If specified, this is the total number of available items. Null if the total is unknown.",
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : items

Type: array

The Groups being returned.

Show Source

• [0]: object XV1GroupInfo
  V1 Group Information DTO.

{
    "description":"The Groups being returned.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/XV1GroupInfo"
    }
}

Nested Schema : XV1GroupInfo

Type: object

V1 Group Information DTO.

Show Source

• addressBuilding: string
  The Group's address.
• addressCity: string
  The Group's address.
• addressCountry: string
  The Group's address.
• addressLine1: string
  The Group's address.
• addressLine2: string
  The Group's address.
• addressOffice: string
  The Group's address.
• addressState: string
  The Group's address.
• addressZipCode: string
  The Group's address ZIP Code.
• altitude: number(double)
  The object's altitude.
• biography: string
  The Group's biography.
• collectionURL: string(url)
  A URL to this object's containing collection.
• company: string
  The Group's company.
• conversationURL: string(url)
  A URL to this object's containing conversation.
• createdByID:
  An object's unique identifier from a long integer representation.
• createdByURL: string(url)
  A URL to the user that created this object.
• createdByUserDisplayName: string
  The display name of the user that created this object.
• createdByUserName: string
  The name of the user that created this object.
• createdDate: string(date)
  The date this object was created.
• createdDateInISO8601Format: string
  The date this object was created, in ISO 8601 format.
• description: string
  The Group description.
• displayName: string
  The display name of this object.
• eMailAddress: string
  The Group's e-mail address.
• expertise: string
  The Group's expertise.
• externalID: string
  Group's external ID.
• fullName: string
  The Group full name.
• groupID: string
  Group's ID.
• groupType: object XV1GroupType
• id:
  An object's unique identifier from a long integer representation.
• interests: string
  The Group's interests.
• isDeleted: boolean
  True if this Group is deleted.
• isEditable: boolean
  True if this Group's Realm allows attributes such as name, membership and enabled status to be edited. The Group's manageable status specifies whether the current user can edit any these fields.
• isInternal: boolean
  True if the Group is internal, False if the Group is external.
• isManageable: boolean
  True if the current User has permissions to edit (manage) this Group.
• isRemoved: boolean
  True if this message has been removed.
• latitude: number(double)
  The object's latitude.
• libraryURL: string(url)
  A URL specifying this Group's library.
• link: string
  A URL if any that the Group shows on their Wall or profile as their Link.
• longitude: number(double)
  The object's longitude.
• membershipURL: string(url)
  A URL to the Membership of this Group.
• membersURL: string(url)
  A URL to the Members of this Group.
• modifiedByID:
  An object's unique identifier from a long integer representation.
• modifiedByURL: string(url)
  A URL to the user that last modified this object.
• modifiedByUserDisplayName: string
  The display name of the user that last modified this object.
• modifiedByUserName: string
  The name of the user that last modified this object.
• modifiedDate: string(date)
  The date this object was last modified.
• modifiedDateInISO8601Format: string
  The date this object was last modified, in ISO 8601 format.
• name: string
  The name of this object.
• objectType: string
  The type of this object.
• organization: string
  The Group's organization.
• originalPictureURL: string(url)
  The original picture URL.
• profilePictureURL: string(url)
  The profile picture URL (150 px by 150 px).
• removedByID:
  An object's unique identifier from a long integer representation.
• removedByURL: string(url)
  A URL to the user that last removed this object.
• removedByUserDisplayName: string
  The display name of the user that last removed this object.
• removedByUserName: string
  The name of the user that last removed this object.
• removedDate: string(date)
  The date this object was removed.
• removedDateInISO8601Format: string
  The date this object was removed, in ISO 8601 format.
• scaledPictureURL: string(url)
  The scaled picture URL (44 px by 44 px).
• socialObjectURL: string(url)
  A URL to this object's containing collaboration object.
• url: string(url)
  A URL to this object.
• wallURL: string(url)
  A URL specifying this Group's wall.

{
    "description":"V1 Group Information DTO.",
    "properties":{
        "addressBuilding":{
            "description":"The Group's address.",
            "type":"string"
        },
        "addressCity":{
            "description":"The Group's address.",
            "type":"string"
        },
        "addressCountry":{
            "description":"The Group's address.",
            "type":"string"
        },
        "addressLine1":{
            "description":"The Group's address.",
            "type":"string"
        },
        "addressLine2":{
            "description":"The Group's address.",
            "type":"string"
        },
        "addressOffice":{
            "description":"The Group's address.",
            "type":"string"
        },
        "addressState":{
            "description":"The Group's address.",
            "type":"string"
        },
        "addressZipCode":{
            "description":"The Group's address ZIP Code.",
            "type":"string"
        },
        "biography":{
            "description":"The Group's biography.",
            "type":"string"
        },
        "company":{
            "description":"The Group's company.",
            "type":"string"
        },
        "description":{
            "description":"The Group description.",
            "type":"string"
        },
        "eMailAddress":{
            "description":"The Group's e-mail address.",
            "type":"string"
        },
        "expertise":{
            "description":"The Group's expertise.",
            "type":"string"
        },
        "externalID":{
            "description":"Group's external ID.",
            "type":"string"
        },
        "fullName":{
            "description":"The Group full name.",
            "type":"string"
        },
        "groupID":{
            "description":"Group's ID.",
            "type":"string"
        },
        "groupType":{
            "$ref":"#/definitions/XV1GroupType"
        },
        "interests":{
            "description":"The Group's interests.",
            "type":"string"
        },
        "isDeleted":{
            "description":"True if this Group is deleted.",
            "type":"boolean"
        },
        "isEditable":{
            "description":"True if this Group's Realm allows attributes such as name, membership and enabled status  to be edited. The Group's manageable status specifies whether the current user can edit any  these fields.",
            "type":"boolean"
        },
        "isInternal":{
            "description":"True if the Group is internal, False if the Group is external.",
            "type":"boolean"
        },
        "isManageable":{
            "description":"True if the current User has permissions to edit (manage) this Group.",
            "type":"boolean"
        },
        "libraryURL":{
            "description":"A URL specifying this Group's library.",
            "type":"string",
            "format":"url"
        },
        "link":{
            "description":"A URL if any that the Group shows on their Wall or profile as their Link.",
            "type":"string"
        },
        "membershipURL":{
            "description":"A URL to the Membership of this Group.",
            "type":"string",
            "format":"url"
        },
        "membersURL":{
            "description":"A URL to the Members of this Group.",
            "type":"string",
            "format":"url"
        },
        "organization":{
            "description":"The Group's organization.",
            "type":"string"
        },
        "wallURL":{
            "description":"A URL specifying this Group's wall.",
            "type":"string",
            "format":"url"
        },
        "originalPictureURL":{
            "description":"The original picture URL.",
            "type":"string",
            "format":"url"
        },
        "profilePictureURL":{
            "description":"The profile picture URL (150 px by 150 px).",
            "type":"string",
            "format":"url"
        },
        "scaledPictureURL":{
            "description":"The scaled picture URL (44 px by 44 px).",
            "type":"string",
            "format":"url"
        },
        "altitude":{
            "description":"The object's altitude.",
            "type":"number",
            "format":"double"
        },
        "collectionURL":{
            "description":"A URL to this object's containing collection.",
            "type":"string",
            "format":"url"
        },
        "conversationURL":{
            "description":"A URL to this object's containing conversation.",
            "type":"string",
            "format":"url"
        },
        "createdByID":{
            "$ref":"#/definitions/XObjectID"
        },
        "createdByURL":{
            "description":"A URL to the user that created this object.",
            "type":"string",
            "format":"url"
        },
        "createdByUserDisplayName":{
            "description":"The display name of the user that created this object.",
            "type":"string"
        },
        "createdByUserName":{
            "description":"The name of the user that created this object.",
            "type":"string"
        },
        "createdDate":{
            "description":"The date this object was created.",
            "type":"string",
            "format":"date"
        },
        "createdDateInISO8601Format":{
            "description":"The date this object was created, in ISO 8601 format.",
            "type":"string"
        },
        "displayName":{
            "description":"The display name of this object.",
            "type":"string"
        },
        "id":{
            "$ref":"#/definitions/XObjectID"
        },
        "isRemoved":{
            "description":"True if this message has been removed.",
            "type":"boolean"
        },
        "latitude":{
            "description":"The object's latitude.",
            "type":"number",
            "format":"double"
        },
        "longitude":{
            "description":"The object's longitude.",
            "type":"number",
            "format":"double"
        },
        "modifiedByID":{
            "$ref":"#/definitions/XObjectID"
        },
        "modifiedByURL":{
            "description":"A URL to the user that last modified this object.",
            "type":"string",
            "format":"url"
        },
        "modifiedByUserDisplayName":{
            "description":"The display name of the user that last modified this object.",
            "type":"string"
        },
        "modifiedByUserName":{
            "description":"The name of the user that last modified this object.",
            "type":"string"
        },
        "modifiedDate":{
            "description":"The date this object was last modified.",
            "type":"string",
            "format":"date"
        },
        "modifiedDateInISO8601Format":{
            "description":"The date this object was last modified, in ISO 8601 format.",
            "type":"string"
        },
        "name":{
            "description":"The name of this object.",
            "type":"string"
        },
        "objectType":{
            "description":"The type of this object.",
            "type":"string"
        },
        "removedByID":{
            "$ref":"#/definitions/XObjectID"
        },
        "removedByURL":{
            "description":"A URL to the user that last removed this object.",
            "type":"string",
            "format":"url"
        },
        "removedByUserDisplayName":{
            "description":"The display name of the user that last removed this object.",
            "type":"string"
        },
        "removedByUserName":{
            "description":"The name of the user that last removed this object.",
            "type":"string"
        },
        "removedDate":{
            "description":"The date this object was removed.",
            "type":"string",
            "format":"date"
        },
        "removedDateInISO8601Format":{
            "description":"The date this object was removed, in ISO 8601 format.",
            "type":"string"
        },
        "socialObjectURL":{
            "description":"A URL to this object's containing collaboration object.",
            "type":"string",
            "format":"url"
        },
        "url":{
            "description":"A URL to this object.",
            "type":"string",
            "format":"url"
        }
    }
}

Nested Schema : XV1GroupType

Type: object

Show Source

• field: string
  Allowed Values: [ "PRIVATE_CLOSED", "PUBLIC_CLOSED", "PUBLIC_OPEN" ]

  V1 group types.

{
    "properties":{
        "field":{
            "type":"string",
            "description":"V1 group types.",
            "enum":[
                "PRIVATE_CLOSED",
                "PUBLIC_CLOSED",
                "PUBLIC_OPEN"
            ]
        }
    }
}