> ## 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 Character Internal Data

> Retrieves the title-specific custom data for the user's character which cannot be accessed by the client

## Error codes

This operation may return the following PlayFab errors:

| Error | Code |
| --- | --- |
| CharacterNotFound | 1135 |
| UserisNotValid | 1030 |




## OpenAPI

````yaml post /Server/GetCharacterInternalData
openapi: 3.0.0
info:
  version: '260922'
  title: PlayFab Server API
  description: >-
    Provides functionality to allow external (developer-controlled) servers to
    interact with user inventories and data in a trusted manner, and to handle
    matchmaking and client connection orchestration
  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: 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
paths:
  /Server/GetCharacterInternalData:
    post:
      tags:
        - Character Data
      summary: Get Character Internal Data
      description: >
        Retrieves the title-specific custom data for the user's character which
        cannot be accessed by the client


        ## Error codes


        This operation may return the following PlayFab errors:


        | Error | Code |

        | --- | --- |

        | CharacterNotFound | 1135 |

        | UserisNotValid | 1030 |
      operationId: GetCharacterInternalData
      requestBody:
        $ref: '#/components/requestBodies/GetCharacterDataRequest'
      responses:
        '200':
          $ref: '#/components/responses/GetCharacterDataResult'
        '400':
          $ref: '#/components/responses/ApiErrorWrapper'
      security:
        - SecretKey: []
components:
  requestBodies:
    GetCharacterDataRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GetCharacterDataRequest'
      description: >-
        Data is stored as JSON key-value pairs. If the Keys parameter is
        provided, the data object returned will only contain the data specific
        to the indicated Keys. Otherwise, the full set of custom user data will
        be returned.
  responses:
    GetCharacterDataResult:
      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/GetCharacterDataResult'
            example:
              code: 200
              status: OK
              data:
                PlayFabId: '2039475'
                DataVersion: 12
                Data:
                  preferences:
                    Value: alpha
                    LastUpdated: '2014-08-20T12:30:45'
                    Permission: Public
                  progress:
                    Value: level_twenty
                    LastUpdated: '2014-09-01T10:12:30'
                CharacterId: '3945734562'
    ApiErrorWrapper:
      description: This is the outer wrapper for all responses with errors
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiErrorWrapper'
  schemas:
    GetCharacterDataRequest:
      description: >-
        Data is stored as JSON key-value pairs. If the Keys parameter is
        provided, the data object returned will only contain the data specific
        to the indicated Keys. Otherwise, the full set of custom user data will
        be returned.
      type: object
      properties:
        CharacterId:
          description: Unique PlayFab assigned ID for a specific character owned by a user
          type: string
        IfChangedFromDataVersion:
          description: >-
            The version that currently exists according to the caller. The call
            will return the data for all of the keys if the version in the
            system is greater than this.
          type: number
          x-actualtype: uint32
        Keys:
          description: Specific keys to search for in the custom user data.
          type: array
          items:
            type: string
        PlayFabId:
          description: >-
            Unique PlayFab assigned ID of the user on whom the operation will be
            performed.
          type: string
      required:
        - PlayFabId
        - CharacterId
      example:
        PlayFabId: '2039475'
        CharacterId: '98342357'
        Keys:
          - preferences
          - progress
        IfChangedFromDataVersion: 1
    GetCharacterDataResult:
      type: object
      properties:
        CharacterId:
          description: Unique PlayFab assigned ID for a specific character owned by a user
          type: string
        Data:
          allOf:
            - $ref: '#/components/schemas/UserDataRecord'
          description: User specific data for this title.
        DataVersion:
          description: >-
            Indicates the current version of the data that has been set. This is
            incremented with every set call for that type of data (read-only,
            internal, etc). This version can be provided in Get calls to find
            updated data.
          type: number
          x-actualtype: uint32
        PlayFabId:
          description: >-
            Unique PlayFab assigned ID of the user on whom the operation will be
            performed.
          type: string
      required:
        - DataVersion
      example:
        PlayFabId: '2039475'
        DataVersion: 12
        Data:
          preferences:
            Value: alpha
            LastUpdated: '2014-08-20T12:30:45'
            Permission: Public
          progress:
            Value: level_twenty
            LastUpdated: '2014-09-01T10:12:30'
        CharacterId: '3945734562'
    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
    UserDataRecord:
      type: object
      properties:
        LastUpdated:
          description: Timestamp for when this data was last updated.
          type: string
        Permission:
          allOf:
            - $ref: '#/components/schemas/UserDataPermission'
          description: >-
            Indicates whether this data can be read by all users (public) or
            only the user (private). This is used for GetUserData requests being
            made by one player about another player.
        Value:
          description: Data stored for the specified user data key.
          type: string
      required:
        - LastUpdated
      example:
        Value: my value
        LastUpdated: '2015-05-15T03:01:09'
        Permission: Public
    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
  securitySchemes:
    SecretKey:
      type: apiKey
      in: header
      name: X-SecretKey
      description: >-
        This API requires a title secret key, available to title admins, from
        PlayFab Game Manager.

````

## Related topics

- [Get Character Internal Data](/api-reference/character-data/get-character-internal-data.md)
- [Profile Reads Meter API Description](/services/playfab/pricing/meters/profile-reads.md)
- [Update Character Internal Data](/services/playfab/api-references/rest/server/character-data/update-character-internal-data.md)
- [Get Character Data](/services/playfab/api-references/rest/client/character-data/get-character-data.md)
- [Get Character Read Only Data](/services/playfab/api-references/rest/client/character-data/get-character-read-only-data.md)
