REST API overview
Welcome to the PlayFab REST API reference. Here you’ll find reference material and gain insight into how our APIs work. Each API reference is broken down into several different sections.Endpoint
The endpoint is the HTTP URL that you can make API requests against. It’s preceded with a REST method type (for example, GET, POST). In addition, the titleId must be replaced with your game titleId. Example:Request Body
The request body is the object model that is sent as (JSON) to our API service. These models contain properties that need to be sent along with your API as the payload. Some properties are flagged as required, while others are optional.Responses
The API service will either return a 200 OK with a JSON payload that can be deserialized as a model. In the below example, Login API calls deserialize into a type of LoginResult.
Security
Each API has some form of security that needs to be passed in the header of each request. See this section to know what needs to be defined. Sometimes this is a session ticket from a login request or it could be your title secret key if you’re making server api requests.Concurrency
The API service is designed to handle a very large number of concurrent calls from each title, but there are limits and restrictions on the number of concurrent calls that can access a single player or other single entity such as a character or group. If this concurrency limit is exceeded, the API returns anAPIConcurrentRequestLimitExceeded or ConcurrentEditError error code. In general, it’s safe to make more than one read request for a given player concurrently, but it’s best to make a single update request at a time.