Skip to main content
POST
Get Task Instances

Authorizations

X-SecretKey
string
header
required

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Body

application/json

Only the most recent 100 task instances are returned, ordered by start time descending. The results are generic basic information for task instances. To get detail information specific to each task type, use Get*TaskInstance based on its corresponding task type.

Only the most recent 100 task instances are returned, ordered by start time descending. The results are generic basic information for task instances. To get detail information specific to each task type, use Get*TaskInstance based on its corresponding task type.

StartedAtRangeFrom
string

Optional range-from filter for task instances' StartedAt timestamp.

StartedAtRangeTo
string

Optional range-to filter for task instances' StartedAt timestamp.

StatusFilter
enum<string>

Optional filter for task instances that are of a specific status.

Available options:
Succeeded,
Starting,
InProgress,
Failed,
Aborted,
Stalled
TaskIdentifier
object

Name or ID of the task whose instances are being queried. If not specified, return all task instances that satisfy conditions set by other filters.

Example:

Response

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object
Example:
Last modified on October 1, 2026