Workday Integration Organizations API

openapi: 3.1.0
info:
  title: Workday Integration Workday Absence Management Absence Types Organizations API
  description: API for managing employee leave requests, absence types, and time-off balances. Retrieves eligible absence types for employees and supports validation of leave category selections.
  version: v1
  contact:
    name: Workday API Support
    email: api-support@workday.com
    url: https://community.workday.com
  license:
    name: Proprietary
    url: https://www.workday.com/en-us/legal/site-terms.html
servers:
- url: https://{baseUrl}/ccx/api/absenceManagement/v1/{tenant}
  description: Workday Absence Management REST API server
  variables:
    baseUrl:
      default: wd2-impl-services1.workday.com
      description: The Workday data center hostname
    tenant:
      default: tenant
      description: The Workday tenant name
security:
- OAuth2:
  - r:absenceManagement
  - w:absenceManagement
tags:
- name: Organizations
paths:
  /workers/{ID}/organizations:
    get:
      operationId: getWorkerOrganizations
      summary: Workday Integration Retrieve organizations for a worker
      description: Returns the organizational memberships for the specified worker, including supervisory organizations and cost centers.
      tags:
      - Organizations
      parameters:
      - $ref: '#/components/parameters/ID'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: Successful response with worker organizations
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationsResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /workers/{ID}/supervisoryOrganizations:
    get:
      operationId: getWorkerSupervisoryOrganizations
      summary: Workday Integration Retrieve supervisory organizations managed by a worker
      description: Returns the supervisory organizations managed by the specified worker.
      tags:
      - Organizations
      parameters:
      - $ref: '#/components/parameters/ID'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: Successful response with supervisory organizations
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupervisoryOrganizationsResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /supervisoryOrganizations:
    get:
      operationId: getSupervisoryOrganizations
      summary: Workday Integration Retrieve all supervisory organizations
      description: Returns a collection of supervisory organizations within the tenant.
      tags:
      - Organizations
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/search'
      responses:
        '200':
          description: Successful response with supervisory organizations
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupervisoryOrganizationsResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /supervisoryOrganizations/{ID}:
    get:
      operationId: getSupervisoryOrganizationById
      summary: Workday Integration Retrieve a specific supervisory organization
      description: Returns the specified supervisory organization including its members and hierarchy.
      tags:
      - Organizations
      parameters:
      - $ref: '#/components/parameters/ID'
      responses:
        '200':
          description: Successful response with the supervisory organization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupervisoryOrganization'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /supervisoryOrganizations/{ID}/workers:
    get:
      operationId: getSupervisoryOrganizationWorkers
      summary: Workday Integration Retrieve workers in a supervisory organization
      description: Returns the workers assigned to the specified supervisory organization.
      tags:
      - Organizations
      parameters:
      - $ref: '#/components/parameters/ID'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: Successful response with workers in the organization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkersResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /organizations:
    get:
      operationId: getOrganizations
      summary: Workday Integration Retrieve all organizations
      description: Returns a collection of organizations including company, cost center, and region organizations.
      tags:
      - Organizations
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/search'
      responses:
        '200':
          description: Successful response with organizations
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationsResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /organizations/{ID}:
    get:
      operationId: getOrganizationById
      summary: Workday Integration Retrieve a specific organization
      description: Returns the specified organization instance.
      tags:
      - Organizations
      parameters:
      - $ref: '#/components/parameters/ID'
      responses:
        '200':
          description: Successful response with the organization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Organization'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /organizationTypes:
    get:
      operationId: getOrganizationTypes
      summary: Workday Integration Retrieve organization types
      description: Returns all available organization types in the tenant.
      tags:
      - Organizations
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: Successful response with organization types
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationTypesResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    WorkerSummary:
      type: object
      properties:
        id:
          type: string
          description: The Workday ID of the worker
        descriptor:
          type: string
          description: The display name of the worker
        href:
          type: string
          format: uri
          description: The API resource URL
    OrganizationsResponse:
      type: object
      properties:
        total:
          type: integer
        data:
          type: array
          items:
            $ref: '#/components/schemas/Organization'
    SupervisoryOrganizationsResponse:
      type: object
      properties:
        total:
          type: integer
        data:
          type: array
          items:
            $ref: '#/components/schemas/SupervisoryOrganization'
    Organization:
      type: object
      properties:
        id:
          type: string
        descriptor:
          type: string
        organizationType:
          $ref: '#/components/schemas/ResourceReference'
        isActive:
          type: boolean
    ResourceReference:
      type: object
      properties:
        id:
          type: string
          description: The Workday ID
        descriptor:
          type: string
          description: The display name
        href:
          type: string
          format: uri
          description: The API resource URL
    WorkersResponse:
      type: object
      properties:
        total:
          type: integer
          description: Total number of results
        data:
          type: array
          items:
            $ref: '#/components/schemas/WorkerSummary'
    OrganizationTypesResponse:
      type: object
      properties:
        total:
          type: integer
        data:
          type: array
          items:
            $ref: '#/components/schemas/ResourceReference'
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: The error code
        errors:
          type: array
          items:
            type: object
            properties:
              error:
                type: string
              field:
                type: string
              message:
                type: string
    SupervisoryOrganization:
      type: object
      properties:
        id:
          type: string
        descriptor:
          type: string
        name:
          type: string
        manager:
          $ref: '#/components/schemas/ResourceReference'
        superior:
          $ref: '#/components/schemas/ResourceReference'
        staffingModel:
          type: string
  responses:
    Forbidden:
      description: Insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  parameters:
    offset:
      name: offset
      in: query
      description: The zero-based index of the first object in a response collection
      schema:
        type: integer
        default: 0
    search:
      name: search
      in: query
      description: Search string used to filter results
      schema:
        type: string
    ID:
      name: ID
      in: path
      required: true
      description: The Workday ID of the resource
      schema:
        type: string
    limit:
      name: limit
      in: query
      description: The maximum number of objects in a single response (default 20, maximum 100)
      schema:
        type: integer
        default: 20
        maximum: 100
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://{baseUrl}/authorize
          tokenUrl: https://{baseUrl}/oauth2/{tenant}/token
          refreshUrl: https://{baseUrl}/oauth2/{tenant}/token
          scopes:
            r:absenceManagement: Read absence data
            w:absenceManagement: Write absence data