> ## 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 Tasks

> Get definition information on a specified task or all tasks within a title.



## OpenAPI

````yaml post /Admin/GetTasks
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/GetTasks:
    post:
      tags:
        - ScheduledTask
      summary: Get Tasks
      description: >-
        Get definition information on a specified task or all tasks within a
        title.
      operationId: GetTasks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetTasksRequest'
      responses:
        '200':
          $ref: '#/components/responses/GetTasksResult'
        '400':
          $ref: '#/components/responses/ApiErrorWrapper'
      security:
        - SecretKey: []
components:
  schemas:
    GetTasksRequest:
      type: object
      properties:
        Identifier:
          allOf:
            - $ref: '#/components/schemas/NameIdentifier'
          description: >-
            Provide either the task ID or the task name to get a specific task.
            If not specified, return all defined tasks.
      example:
        Identifier:
          Name: EnableDailyHappyHour
    NameIdentifier:
      description: >-
        Identifier by either name or ID. Note that a name may change due to
        renaming, or reused after being deleted. ID is immutable and unique.
      type: object
      properties:
        Id:
          description: Id Identifier, if present
          type: string
        Name:
          description: Name Identifier, if present
          type: string
      example:
        Name: MyTask
        Id: d739e188-22f6-4d13-a4d5-df2e93d4d2f7
    GetTasksResult:
      type: object
      properties:
        Tasks:
          description: Result tasks. Empty if there is no task found.
          type: array
          items:
            $ref: '#/components/schemas/ScheduledTask'
          x-isclass: true
      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'
    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
    ScheduledTask:
      type: object
      properties:
        Description:
          description: Description the task
          type: string
        IsActive:
          description: >-
            Whether the schedule is active. Inactive schedule will not trigger
            task execution.
          type: boolean
        LastRunTime:
          description: UTC time of last run
          type: string
        Name:
          description: >-
            Name of the task. This is a unique identifier for tasks in the
            title.
          type: string
        NextRunTime:
          description: UTC time of next run
          type: string
        Parameter:
          description: >-
            Task parameter. Different types of task have different parameter
            structure. See each task type's create API documentation for the
            details.
          type: object
        Schedule:
          description: >-
            Cron expression for the run schedule of the task. The expression
            should be in UTC.
          type: string
        TaskId:
          description: ID of the task
          type: string
        Type:
          allOf:
            - $ref: '#/components/schemas/ScheduledTaskType'
          description: Task type.
      required:
        - Name
        - IsActive
      example:
        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'
    ScheduledTaskType:
      type: string
      enum:
        - CloudScript
        - ActionsOnPlayerSegment
        - CloudScriptAzureFunctions
        - InsightsScheduledScaling
  responses:
    GetTasksResult:
      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/GetTasksResult'
            example:
              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'
    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 Tasks](/api-reference/scheduledtask/get-tasks.md)
- [Get Task Instances](/api-reference/scheduledtask/get-task-instances.md)
- [Get Cloud Script Task Instance](/api-reference/scheduledtask/get-cloud-script-task-instance.md)
- [Get Actions On Players In Segment Task Instance](/api-reference/scheduledtask/get-actions-on-players-in-segment-task-instance.md)
- [XTaskQueueGetCurrentProcessTaskQueue](/reference/system/xtaskqueue/functions/xtaskqueuegetcurrentprocesstaskqueue.md)
