Get Tasks
Get definition information on a specified task or all tasks within a title.
POST
/
Admin
/
GetTasks
Get Tasks
curl --request POST \
--url https://{titleId}.playfabapi.com/Admin/GetTasks \
--header 'Content-Type: application/json' \
--header 'X-SecretKey: <api-key>' \
--data '
{
"Identifier": {
"Name": "EnableDailyHappyHour"
}
}
'import requests
url = "https://{titleId}.playfabapi.com/Admin/GetTasks"
payload = { "Identifier": { "Name": "EnableDailyHappyHour" } }
headers = {
"X-SecretKey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-SecretKey': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({Identifier: {Name: 'EnableDailyHappyHour'}})
};
fetch('https://{titleId}.playfabapi.com/Admin/GetTasks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{titleId}.playfabapi.com/Admin/GetTasks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'Identifier' => [
'Name' => 'EnableDailyHappyHour'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-SecretKey: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{titleId}.playfabapi.com/Admin/GetTasks"
payload := strings.NewReader("{\n \"Identifier\": {\n \"Name\": \"EnableDailyHappyHour\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-SecretKey", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Admin/GetTasks")
.header("X-SecretKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"Identifier\": {\n \"Name\": \"EnableDailyHappyHour\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/Admin/GetTasks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-SecretKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"Identifier\": {\n \"Name\": \"EnableDailyHappyHour\"\n }\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"status": "OK",
"data": {
"Tasks": [
{
"TaskId": "9742767689DA713",
"Name": "EnableDailyHappyHour",
"Description": "Turn on special pricing for weekday happy-hour",
"Schedule": "0 17 * * 1-5",
"Parameter": {
"FunctionName": "applyStorePreset",
"Argument": {
"preset": "WeekdayHappyHour"
}
},
"LastRunTime": "2016-10-19T05:43:19",
"NextRunTime": "2016-10-19T17:00:00"
}
]
}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}Authorizations
This API requires a title secret key, available to title admins, from PlayFab Game Manager.
Body
application/json
Provide either the task ID or the task name to get a specific task. If not specified, return all defined tasks.
Show child attributes
Show child attributes
Example:
{ "Name": "MyTask", "Id": "d739e188-22f6-4d13-a4d5-df2e93d4d2f7" }
Response
The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.
The Http status code as a string.
Show child attributes
Show child attributes
Example:
{ "Tasks": [ { "TaskId": "9742767689DA713", "Name": "EnableDailyHappyHour", "Description": "Turn on special pricing for weekday happy-hour", "Schedule": "0 17 * * 1-5", "Parameter": { "FunctionName": "applyStorePreset", "Argument": { "preset": "WeekdayHappyHour" } }, "LastRunTime": "2016-10-19T05:43:19", "NextRunTime": "2016-10-19T17:00:00" } ] }
Last modified on October 1, 2026
Was this page helpful?
⌘I
Get Tasks
curl --request POST \
--url https://{titleId}.playfabapi.com/Admin/GetTasks \
--header 'Content-Type: application/json' \
--header 'X-SecretKey: <api-key>' \
--data '
{
"Identifier": {
"Name": "EnableDailyHappyHour"
}
}
'import requests
url = "https://{titleId}.playfabapi.com/Admin/GetTasks"
payload = { "Identifier": { "Name": "EnableDailyHappyHour" } }
headers = {
"X-SecretKey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-SecretKey': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({Identifier: {Name: 'EnableDailyHappyHour'}})
};
fetch('https://{titleId}.playfabapi.com/Admin/GetTasks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{titleId}.playfabapi.com/Admin/GetTasks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'Identifier' => [
'Name' => 'EnableDailyHappyHour'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-SecretKey: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{titleId}.playfabapi.com/Admin/GetTasks"
payload := strings.NewReader("{\n \"Identifier\": {\n \"Name\": \"EnableDailyHappyHour\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-SecretKey", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Admin/GetTasks")
.header("X-SecretKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"Identifier\": {\n \"Name\": \"EnableDailyHappyHour\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/Admin/GetTasks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-SecretKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"Identifier\": {\n \"Name\": \"EnableDailyHappyHour\"\n }\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"status": "OK",
"data": {
"Tasks": [
{
"TaskId": "9742767689DA713",
"Name": "EnableDailyHappyHour",
"Description": "Turn on special pricing for weekday happy-hour",
"Schedule": "0 17 * * 1-5",
"Parameter": {
"FunctionName": "applyStorePreset",
"Argument": {
"preset": "WeekdayHappyHour"
}
},
"LastRunTime": "2016-10-19T05:43:19",
"NextRunTime": "2016-10-19T17:00:00"
}
]
}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}