PlayFab

aid: playfab
name: PlayFab
description: >-
  PlayFab is Microsoft Azure's backend-as-a-service for live games. PlayFab
  exposes a large REST API surface (Client, Server, Admin, Authentication,
  CloudScript, Multiplayer, Economy v2, Matchmaking, Insights, Groups, Data,
  Profiles, Events, Localization) plus first-party SDKs for Unity, Unreal,
  Cocos, Phaser, JavaScript, C++, C#, Java, Lua, Objective-C, and Python.
  Every PlayFab game (a "title") gets its own scoped subdomain at
  https://[titleId].playfabapi.com. Sessions, identity, progression,
  inventory, leaderboards, segmentation, A/B testing, push, scheduled tasks,
  CloudScript (Azure Functions), and PlayFab Multiplayer Servers all run on
  this surface. PlayFab is operated as part of Azure Gaming and the
  documentation lives at learn.microsoft.com/en-us/gaming/playfab.
image: https://kinlane-productions2.s3.amazonaws.com/apis-json/apis-json-logo.jpg
url: https://playfab.com
created: '2024-01-01'
modified: '2026-05-23'
specificationVersion: '0.19'
type: Index
access: 3rd-Party
tags:
  - Authentication
  - Azure
  - Backend
  - BaaS
  - CloudScript
  - Economy
  - Game Backend
  - Game Development
  - Games
  - Leaderboards
  - Matchmaking
  - Microsoft
  - Multiplayer
  - PlayFab
  - REST
apis:
  - aid: playfab:playfab-client-api
    name: PlayFab Client API
    description: >-
      The PlayFab Client API is the player-facing REST surface used by game
      clients for login, account linking, virtual currency, inventory,
      friends, leaderboards, statistics, player data, cloud script execution,
      multiplayer session lookup, push registration, segmentation triggers,
      and analytics events. It is scoped per-title at
      https://[titleId].playfabapi.com/Client and authenticated with a
      session ticket issued from a Login* call.
    image: https://kinlane-productions2.s3.amazonaws.com/apis-json/apis-json-logo.jpg
    humanURL: https://learn.microsoft.com/en-us/rest/api/playfab/client/
    baseURL: https://titleId.playfabapi.com/Client
    tags:
      - Authentication
      - Client
      - Leaderboards
      - Players
    properties:
      - type: Documentation
        url: https://learn.microsoft.com/en-us/rest/api/playfab/client/
      - type: Authentication
        url: https://learn.microsoft.com/en-us/gaming/playfab/sdks/playfab-authentication
  - aid: playfab:playfab-server-api
    name: PlayFab Server API
    description: >-
      The PlayFab Server API is the server-trusted REST surface for custom
      game servers and trusted backends. It mirrors much of the Client API
      but operates with the title's developer secret key and can act on any
      player, grant items, adjust currencies, modify read-only data, and
      issue server-authoritative writes.
    image: https://kinlane-productions2.s3.amazonaws.com/apis-json/apis-json-logo.jpg
    humanURL: https://learn.microsoft.com/en-us/rest/api/playfab/server/
    baseURL: https://titleId.playfabapi.com/Server
    tags:
      - Game Servers
      - Server
      - Trusted
    properties:
      - type: Documentation
        url: https://learn.microsoft.com/en-us/rest/api/playfab/server/
  - aid: playfab:playfab-admin-api
    name: PlayFab Admin API
    description: >-
      The PlayFab Admin API is the privileged REST surface for studio and
      ops tooling. It covers title configuration, virtual currency catalogs,
      catalog items, store configuration, content (CDN) uploads, segments,
      tasks, policies, players (ban, refund, reset), and CloudScript
      revisions. Authenticated with the title developer secret key.
    image: https://kinlane-productions2.s3.amazonaws.com/apis-json/apis-json-logo.jpg
    humanURL: https://learn.microsoft.com/en-us/rest/api/playfab/admin/
    baseURL: https://titleId.playfabapi.com/Admin
    tags:
      - Admin
      - LiveOps
      - Tooling
    properties:
      - type: Documentation
        url: https://learn.microsoft.com/en-us/rest/api/playfab/admin/
  - aid: playfab:playfab-authentication-api
    name: PlayFab Authentication API
    description: >-
      The PlayFab Authentication API issues and validates entity tokens used
      by the Entity Programming Model that underlies CloudScript using Azure
      Functions, Groups, Data, Profiles, Events, and Multiplayer. Entity
      tokens scope calls to a master player, character, title, group, or
      namespace entity.
    image: https://kinlane-productions2.s3.amazonaws.com/apis-json/apis-json-logo.jpg
    humanURL: https://learn.microsoft.com/en-us/rest/api/playfab/authentication/
    baseURL: https://titleId.playfabapi.com/Authentication
    tags:
      - Authentication
      - Entity
      - Identity
      - Tokens
    properties:
      - type: Documentation
        url: https://learn.microsoft.com/en-us/rest/api/playfab/authentication/
  - aid: playfab:playfab-cloudscript-api
    name: PlayFab CloudScript API
    description: >-
      PlayFab CloudScript runs server-authoritative game logic in PlayFab.
      Modern CloudScript using Azure Functions registers Azure Function
      endpoints that can be invoked from clients or servers via
      ExecuteFunction. Legacy CloudScript runs JavaScript revisions stored
      in the title.
    image: https://kinlane-productions2.s3.amazonaws.com/apis-json/apis-json-logo.jpg
    humanURL: https://learn.microsoft.com/en-us/rest/api/playfab/cloudscript/
    baseURL: https://titleId.playfabapi.com/CloudScript
    tags:
      - Azure Functions
      - CloudScript
      - Serverless
    properties:
      - type: Documentation
        url: https://learn.microsoft.com/en-us/rest/api/playfab/cloudscript/
  - aid: playfab:playfab-multiplayer-api
    name: PlayFab Multiplayer API
    description: >-
      The PlayFab Multiplayer API powers PlayFab Multiplayer Servers
      (managed game server hosting on Azure), Party (low-latency voice and
      data networking), Lobby, and matchmaking server build management.
    image: https://kinlane-productions2.s3.amazonaws.com/apis-json/apis-json-logo.jpg
    humanURL: https://learn.microsoft.com/en-us/rest/api/playfab/multiplayer/
    baseURL: https://titleId.playfabapi.com/Multiplayer
    tags:
      - Game Servers
      - Lobby
      - Multiplayer
      - Party
    properties:
      - type: Documentation
        url: https://learn.microsoft.com/en-us/rest/api/playfab/multiplayer/
  - aid: playfab:playfab-matchmaking-api
    name: PlayFab Matchmaking API
    description: >-
      The PlayFab Matchmaking API exposes ticket-based matchmaking, queue
      management, match results, and matchmaking rule configuration on top
      of PlayFab Multiplayer.
    image: https://kinlane-productions2.s3.amazonaws.com/apis-json/apis-json-logo.jpg
    humanURL: https://learn.microsoft.com/en-us/rest/api/playfab/matchmaker/
    baseURL: https://titleId.playfabapi.com/Match
    tags:
      - Matchmaking
      - Multiplayer
      - Queues
    properties:
      - type: Documentation
        url: https://learn.microsoft.com/en-us/rest/api/playfab/matchmaker/
  - aid: playfab:playfab-economy-api
    name: PlayFab Economy (Catalog / Inventory) API
    description: >-
      PlayFab Economy v2 is the modern catalog, inventory, store, and
      virtual-currency surface. It covers catalog item authoring, inventory
      transactions, transactional and subscription stores, item search, and
      content review workflows for UGC.
    image: https://kinlane-productions2.s3.amazonaws.com/apis-json/apis-json-logo.jpg
    humanURL: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/
    baseURL: https://titleId.playfabapi.com/Catalog
    tags:
      - Catalog
      - Currency
      - Economy
      - Inventory
      - Store
      - UGC
    properties:
      - type: Documentation
        url: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/
  - aid: playfab:playfab-data-api
    name: PlayFab Data API
    description: >-
      The PlayFab Data API stores arbitrary file and object data attached
      to any entity (player, title, character, group). It exposes
      GetFiles, GetObjects, InitiateFileUploads, AbortFileUploads,
      FinalizeFileUploads, SetObjects, and DeleteFiles, used for save
      games, UGC blobs, and per-entity JSON state.
    image: https://kinlane-productions2.s3.amazonaws.com/apis-json/apis-json-logo.jpg
    humanURL: https://learn.microsoft.com/en-us/rest/api/playfab/data/
    baseURL: https://titleId.playfabapi.com/File
    tags:
      - Data
      - Entity
      - Files
      - Save Data
    properties:
      - type: Documentation
        url: https://learn.microsoft.com/en-us/rest/api/playfab/data/
  - aid: playfab:playfab-groups-api
    name: PlayFab Groups API
    description: >-
      The PlayFab Groups API supports guilds, clans, parties, and other
      player-managed organizations on the Entity model with roles,
      memberships, applications, and invitations.
    image: https://kinlane-productions2.s3.amazonaws.com/apis-json/apis-json-logo.jpg
    humanURL: https://learn.microsoft.com/en-us/rest/api/playfab/groups/
    baseURL: https://titleId.playfabapi.com/Group
    tags:
      - Clans
      - Groups
      - Guilds
      - Social
    properties:
      - type: Documentation
        url: https://learn.microsoft.com/en-us/rest/api/playfab/groups/
  - aid: playfab:playfab-profiles-api
    name: PlayFab Profiles API
    description: >-
      The PlayFab Profiles API reads and writes Entity Profiles, including
      display name, language, lineage, and per-entity policies (ACLs) used
      across the Entity-model APIs.
    image: https://kinlane-productions2.s3.amazonaws.com/apis-json/apis-json-logo.jpg
    humanURL: https://learn.microsoft.com/en-us/rest/api/playfab/profiles/
    baseURL: https://titleId.playfabapi.com/Profile
    tags:
      - Entity
      - Permissions
      - Profiles
    properties:
      - type: Documentation
        url: https://learn.microsoft.com/en-us/rest/api/playfab/profiles/
  - aid: playfab:playfab-events-api
    name: PlayFab Events API
    description: >-
      The PlayFab Events API writes PlayStream and custom telemetry events
      into PlayFab's pipeline for downstream segmentation, rules, and
      Insights analytics.
    image: https://kinlane-productions2.s3.amazonaws.com/apis-json/apis-json-logo.jpg
    humanURL: https://learn.microsoft.com/en-us/rest/api/playfab/events/
    baseURL: https://titleId.playfabapi.com/Event
    tags:
      - Analytics
      - Events
      - PlayStream
      - Telemetry
    properties:
      - type: Documentation
        url: https://learn.microsoft.com/en-us/rest/api/playfab/events/
  - aid: playfab:playfab-insights-api
    name: PlayFab Insights API
    description: >-
      PlayFab Insights is the managed analytics surface (built on Azure
      Data Explorer / Kusto) for querying telemetry generated by PlayFab
      titles. The Insights API manages Insights performance levels and
      submits analytics queries.
    image: https://kinlane-productions2.s3.amazonaws.com/apis-json/apis-json-logo.jpg
    humanURL: https://learn.microsoft.com/en-us/gaming/playfab/features/analytics/insights/
    baseURL: https://insights.playfab.com
    tags:
      - Analytics
      - Insights
      - Kusto
      - Reporting
    properties:
      - type: Documentation
        url: https://learn.microsoft.com/en-us/gaming/playfab/features/analytics/insights/
  - aid: playfab:playfab-localization-api
    name: PlayFab Localization API
    description: >-
      The PlayFab Localization API returns the set of languages supported
      by the title and is used by clients to negotiate locale.
    image: https://kinlane-productions2.s3.amazonaws.com/apis-json/apis-json-logo.jpg
    humanURL: https://learn.microsoft.com/en-us/rest/api/playfab/localization/
    baseURL: https://titleId.playfabapi.com/Locale
    tags:
      - i18n
      - Localization
    properties:
      - type: Documentation
        url: https://learn.microsoft.com/en-us/rest/api/playfab/localization/
common:
  - url: https://playfab.com
    name: PlayFab Website
    type: Website
  - url: https://developer.playfab.com
    name: PlayFab Game Manager
    type: Portal
  - url: https://learn.microsoft.com/en-us/gaming/playfab/
    name: PlayFab Documentation
    type: Documentation
  - url: https://learn.microsoft.com/en-us/rest/api/playfab/
    name: PlayFab REST API Reference
    type: APIReference
  - url: https://learn.microsoft.com/en-us/gaming/playfab/sdks/
    name: PlayFab SDKs
    type: SDK
  - url: https://learn.microsoft.com/en-us/gaming/playfab/personas/developer
    name: PlayFab for Developers
    type: GettingStarted
  - url: https://learn.microsoft.com/en-us/gaming/playfab/features/pricing/
    name: PlayFab Pricing
    type: Pricing
  - url: https://learn.microsoft.com/en-us/gaming/playfab/personas/release-notes
    name: PlayFab Release Notes
    type: ReleaseNotes
  - url: https://status.playfab.com
    name: PlayFab Status
    type: Status
  - url: https://community.playfab.com
    name: PlayFab Community Forums
    type: Forum
  - url: https://github.com/PlayFab
    name: PlayFab on GitHub
    type: GitHubOrganization
  - url: https://blog.playfab.com
    name: PlayFab Blog
    type: Blog
  - url: https://www.microsoft.com/en-us/servicesagreement/
    name: Microsoft Services Agreement
    type: TermsOfService
  - url: https://privacy.microsoft.com/en-us/privacystatement
    name: Microsoft Privacy Statement
    type: PrivacyPolicy
  - url: https://x.com/AzurePlayFab
    name: Azure PlayFab on X
    type: X
  - url: https://www.linkedin.com/showcase/microsoft-azure
    name: Microsoft Azure on LinkedIn
    type: LinkedIn
maintainers:
  - FN: Kin Lane
    email: [email protected]