> ## 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 Player Custom Property

> Retrieves a title-specific custom property value for a player.

## Error codes

This operation may return the following PlayFab errors:

| Error | Code |
| --- | --- |
| PlayerCustomPropertiesPropertyDoesNotExist | 19007 |




## OpenAPI

````yaml post /Admin/GetPlayerCustomProperty
openapi: 3.0.0
info:
  version: '260922'
  title: PlayFab Admin API
  description: >-
    APIs for managing title configurations, uploaded Game Server code
    executables, and user data
  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: Authentication
    description: Authentication APIs
  - name: Characters
    description: Characters APIs
  - name: Content
    description: Content Service APIs
  - name: Custom Server Management
    description: Custom Server Management APIs
  - name: Matchmaking
    description: Matchmaking 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: ScheduledTask
    description: Task management APIs
  - name: Segments
    description: Segment 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: Xbox Store
    description: Xbox Store APIs
paths:
  /Admin/GetPlayerCustomProperty:
    post:
      tags:
        - Player Data Management
      summary: Get Player Custom Property
      description: |
        Retrieves a title-specific custom property value for a player.

        ## Error codes

        This operation may return the following PlayFab errors:

        | Error | Code |
        | --- | --- |
        | PlayerCustomPropertiesPropertyDoesNotExist | 19007 |
      operationId: GetPlayerCustomProperty
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetPlayerCustomPropertyRequest'
      responses:
        '200':
          $ref: '#/components/responses/GetPlayerCustomPropertyResult'
        '400':
          $ref: '#/components/responses/ApiErrorWrapper'
      security:
        - SecretKey: []
components:
  schemas:
    GetPlayerCustomPropertyRequest:
      type: object
      properties:
        PlayFabId:
          description: >-
            Unique PlayFab assigned ID of the user on whom the operation will be
            performed.
          type: string
        PropertyName:
          description: Specific property name to search for in the player's properties.
          type: string
      required:
        - PlayFabId
        - PropertyName
      example:
        PlayFabId: '2039475'
        PropertyName: level
    GetPlayerCustomPropertyResult:
      type: object
      properties:
        PlayFabId:
          description: >-
            PlayFab unique identifier of the user whose properties are being
            returned.
          type: string
        PropertiesVersion:
          description: >-
            Indicates the current version of a player's properties that have
            been set. This is incremented after updates and deletes. This
            version can be provided in update and delete calls for concurrency
            control.
          type: number
          x-actualtype: int32
        Property:
          allOf:
            - $ref: '#/components/schemas/CustomPropertyDetails'
          description: Player specific property and its corresponding value.
      required:
        - PropertiesVersion
      example:
        PlayFabId: '2039475'
        Property:
          Name: level
          Value: 5
        PropertiesVersion: 12
    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
    CustomPropertyDetails:
      type: object
      properties:
        Name:
          description: The custom property's name.
          type: string
        Value:
          description: The custom property's value.
          type: object
  responses:
    GetPlayerCustomPropertyResult:
      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/GetPlayerCustomPropertyResult'
            example:
              code: 200
              status: OK
              data:
                PlayFabId: '2039475'
                Property:
                  Name: level
                  Value: 5
                PropertiesVersion: 12
    ApiErrorWrapper:
      description: This is the outer wrapper for all responses with errors
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiErrorWrapper'
  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 Player Custom Property](/api-reference/player-data-management/get-player-custom-property.md)
- [PFPlayerDataManagementClientGetPlayerCustomPropertyAsync](/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementclientgetplayercustompropertyasync.md)
- [PFPlayerDataManagementServerGetPlayerCustomPropertyAsync](/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementservergetplayercustompropertyasync.md)
- [PFPlayerDataManagementServerUpdatePlayerCustomPropertiesAsync](/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementserverupdateplayercustompropertiesasync.md)
- [PFPlayerDataManagementServerDeletePlayerCustomPropertiesAsync](/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementserverdeleteplayercustompropertiesasync.md)