> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Shared Group Data

> Retrieves data stored in a shared group object, as well as the list of members in the group. Non-members of the group may use this to retrieve group data, including membership, but they will not receive data for keys marked as private. Shared Groups are designed for sharing data between a very small number of players, please see our guide: https://learn.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data

## Error codes

This operation may return the following PlayFab errors:

| Error | Code |
| --- | --- |
| ProductDisabledForTitle | 1609 |




## OpenAPI

````yaml post /Client/GetSharedGroupData
openapi: 3.0.0
info:
  version: '260922'
  title: PlayFab Client API
  description: >-
    APIs which provide the full range of PlayFab features available to the
    client - authentication, account and data management, inventory, friends,
    matchmaking, reporting, and platform-specific functionality
  termsOfService: https://playfab.com/terms/
  contact:
    url: https://community.playfab.com/index.html
  license:
    name: Apache 2.0
    url: https://github.com/PlayFab/API_Specs/blob/master/LICENSE
servers:
  - url: https://{titleId}.playfabapi.com
    description: PlayFab title endpoint
    variables:
      titleId:
        default: your_title_id
        description: Your PlayFab title ID (hex).
security: []
tags:
  - name: Account Management
    description: Account Management APIs
  - name: Advertising
    description: Advertising APIs
  - name: Analytics
    description: Analytics APIs
  - name: Authentication
    description: Authentication APIs
  - name: Character Data
    description: Character Data APIs
  - name: Characters
    description: Characters APIs
  - name: Content
    description: Content Service APIs
  - name: Friend List Management
    description: Friend List Management APIs
  - name: Matchmaking
    description: Matchmaking APIs
  - name: Platform Specific Methods
    description: Platform Specific Methods APIs
  - name: Player Data Management
    description: Player Data Management APIs
  - name: Player Item Management
    description: Player Item Management APIs
  - name: PlayStream
    description: PlayStream Management APIs
  - name: Server-Side Cloud Script
    description: Server-Side Cloud Script APIs
  - name: Shared Group Data
    description: Shared Group Data APIs
  - name: Title-Wide Data Management
    description: Title-Wide Data Management APIs
  - name: Trading
    description: Trading Management APIs
paths:
  /Client/GetSharedGroupData:
    post:
      tags:
        - Shared Group Data
      summary: Get Shared Group Data
      description: >
        Retrieves data stored in a shared group object, as well as the list of
        members in the group. Non-members of the group may use this to retrieve
        group data, including membership, but they will not receive data for
        keys marked as private. Shared Groups are designed for sharing data
        between a very small number of players, please see our guide:
        https://learn.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data


        ## Error codes


        This operation may return the following PlayFab errors:


        | Error | Code |

        | --- | --- |

        | ProductDisabledForTitle | 1609 |
      operationId: GetSharedGroupData
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetSharedGroupDataRequest'
      responses:
        '200':
          $ref: '#/components/responses/GetSharedGroupDataResult'
        '400':
          $ref: '#/components/responses/ApiErrorWrapper'
      security:
        - SessionTicket: []
components:
  schemas:
    GetSharedGroupDataRequest:
      type: object
      properties:
        GetMembers:
          description: If true, return the list of all members of the shared group.
          type: boolean
        Keys:
          description: >-
            Specific keys to retrieve from the shared group (if not specified,
            all keys will be returned, while an empty array indicates that no
            keys should be returned).
          type: array
          items:
            type: string
        SharedGroupId:
          description: Unique identifier for the shared group.
          type: string
      required:
        - SharedGroupId
      example:
        SharedGroupId: Clan Data
        Keys:
          - ClanKills
          - LastClanUpdate
        GetMembers: true
    GetSharedGroupDataResult:
      type: object
      properties:
        Data:
          allOf:
            - $ref: '#/components/schemas/SharedGroupDataRecord'
          description: Data for the requested keys.
        Members:
          description: >-
            List of PlayFabId identifiers for the members of this group, if
            requested.
          type: array
          items:
            type: string
      example:
        Data:
          ClanKills:
            Value: '34'
            LastUpdatedBy: D984A64B832
            LastUpdated: '2015-01-03T17:44:21'
            Permission: Public
          LastClanUpdate:
            Value: '2015-01-03T17:44:21Z'
            LastUpdatedBy: D984A64B832
            LastUpdated: '2015-01-03T17:44:21'
        Members:
          - D984A64B832
          - F74A523E1562
    ApiErrorWrapper:
      description: The basic wrapper around every failed API response
      type: object
      properties:
        code:
          description: Numerical HTTP code
          type: integer
        status:
          description: String HTTP code
          type: string
        error:
          description: Playfab error code
          type: string
        errorCode:
          description: Numerical PlayFab error code
          type: integer
        errorMessage:
          description: Description for the PlayFab errorCode
          type: string
        errorDetails:
          description: Detailed description of individual issues with the request object
          type: object
      required:
        - code
        - errorCode
    SharedGroupDataRecord:
      type: object
      properties:
        LastUpdated:
          description: Timestamp for when this data was last updated.
          type: string
        LastUpdatedBy:
          description: Unique PlayFab identifier of the user to last update this value.
          type: string
        Permission:
          allOf:
            - $ref: '#/components/schemas/UserDataPermission'
          description: >-
            Indicates whether this data can be read by all users (public) or
            only members of the group (private).
        Value:
          description: Data stored for the specified group data key.
          type: string
      required:
        - LastUpdated
    UserDataPermission:
      description: >-
        Indicates whether a given data key is private (readable only by the
        player) or public (readable by all players). When a player makes a
        GetUserData request about another player, only keys marked Public will
        be returned.
      type: string
      enum:
        - Private
        - Public
  responses:
    GetSharedGroupDataResult:
      description: ''
      content:
        application/json:
          schema:
            type: object
            properties:
              code:
                type: integer
                description: >-
                  The Http status code. If X-ReportErrorAsSuccess header is set
                  to true, this will report the actual http error code.
              status:
                type: string
                description: The Http status code as a string.
              data:
                $ref: '#/components/schemas/GetSharedGroupDataResult'
            example:
              code: 200
              status: OK
              data:
                Data:
                  ClanKills:
                    Value: '34'
                    LastUpdatedBy: D984A64B832
                    LastUpdated: '2015-01-03T17:44:21'
                    Permission: Public
                  LastClanUpdate:
                    Value: '2015-01-03T17:44:21Z'
                    LastUpdatedBy: D984A64B832
                    LastUpdated: '2015-01-03T17:44:21'
                Members:
                  - D984A64B832
                  - F74A523E1562
    ApiErrorWrapper:
      description: This is the outer wrapper for all responses with errors
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiErrorWrapper'
  securitySchemes:
    SessionTicket:
      type: apiKey
      in: header
      name: X-Authorization
      description: >-
        This API requires a client session ticket, available from any Client
        Login function.

````

## Related topics

- [Get Shared Group Data](/api-reference/shared-group-data/get-shared-group-data.md)
- [Update Shared Group Data](/services/playfab/api-references/rest/client/shared-group-data/update-shared-group-data.md)
- [Using Shared Group Data](/services/playfab/community/associations/groups/using-shared-group-data.md)
- [Delete Shared Group](/api-reference/shared-group-data/delete-shared-group.md)
- [Create Shared Group](/services/playfab/api-references/rest/client/shared-group-data/create-shared-group.md)
