Workday Report Writer Query Execution API

openapi: 3.2.0
info:
  title: Workday Report Writer Workday WQL Query Execution API
  description: Workday Query Language (WQL) API enabling SQL-like querying of Workday data through REST endpoints. Allows developers to construct queries using SELECT, FROM, WHERE, ORDER BY, and LIMIT syntax to retrieve report data with high performance. Supports pagination, data source discovery, and field metadata retrieval, controlled via OAuth 2.0 bearer tokens.
  version: v1
  contact:
    name: Workday Support
    url: https://www.workday.com/en-us/company/contact-us.html
  termsOfService: https://www.workday.com/en-us/legal.html
servers:
- url: https://{hostname}/ccx/api/wql/v1/{tenant}
  description: Workday WQL Production
  variables:
    hostname:
      description: Workday data center hostname, varies by tenant deployment
      default: wd2-impl-services1.workday.com
    tenant:
      description: Workday tenant name
      default: your-tenant
security:
- bearerAuth: []
tags:
- name: Query Execution
  description: Execute WQL queries against Workday data sources and retrieve paginated results
paths:
  /data:
    get:
      operationId: executeWqlQuery
      summary: Workday Report Writer Execute a WQL Query
      description: Execute a Workday Query Language (WQL) query and retrieve paginated results. Supports SQL-like syntax with SELECT, FROM, WHERE, ORDER BY, and LIMIT clauses. WQL also supports special operators such as startsWith, contains, and endsWith for text filtering.
      tags:
      - Query Execution
      parameters:
      - name: query
        in: query
        required: true
        description: 'WQL query string using SQL-like syntax. Example: SELECT workdayID, fullName FROM workers WHERE supervisoryOrganization = ''IT Department'' ORDER BY fullName LIMIT 100'
        schema:
          type: string
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: Query executed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WqlQueryResult'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  parameters:
    offset:
      name: offset
      in: query
      description: Number of results to skip for pagination
      schema:
        type: integer
        default: 0
    limit:
      name: limit
      in: query
      description: Maximum number of results to return per page
      schema:
        type: integer
        default: 20
        maximum: 100
  responses:
    BadRequest:
      description: The WQL query was malformed, contained invalid syntax, or referenced a non-existent data source or field
    Unauthorized:
      description: Authentication credentials are missing or invalid, or the OAuth 2.0 token lacks the required Workday Query Language scope
  schemas:
    WqlQueryResult:
      type: object
      description: Result set from a WQL query execution containing the matched rows and pagination metadata
      properties:
        total:
          type: integer
          description: Total number of rows matching the query
        data:
          type: array
          items:
            type: object
            additionalProperties: true
          description: Array of result rows where each object contains key-value pairs corresponding to the selected fields in the WQL query
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth 2.0 bearer token obtained from Workday token endpoint. Requires the System - Workday Query Language scope.
externalDocs:
  description: Workday REST API Documentation
  url: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html