Workday Talent API

openapi: 3.1.0
info:
  title: Workday Integration Workday Talent API
  description: >-
    API for managing talent profiles, succession planning, and career
    development. Supports mentorship program management and talent pool
    operations within the organization.
  version: v1
  contact:
    name: Workday API Support
    email: [email protected]
    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/talent/v1/{tenant}
    description: Workday Talent REST API server
    variables:
      baseUrl:
        default: wd2-impl-services1.workday.com
      tenant:
        default: tenant
security:
  - OAuth2:
      - r:talent
      - w:talent
paths:
  /mentorships:
    get:
      operationId: getMentorships
      summary: Workday Integration Retrieve mentorships
      description: >-
        Returns a collection of active and completed mentorship relationships.
      tags:
        - Mentorships
      parameters:
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: Successful response with mentorships
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MentorshipsResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /createMentorshipForMe:
    post:
      operationId: createMentorshipForMe
      summary: Workday Integration Create a mentorship for the current user
      description: >-
        Creates a mentorship relationship where the current authenticated
        user is the mentee.
      tags:
        - Mentorships
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MentorshipRequest'
      responses:
        '201':
          description: Mentorship created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Mentorship'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /createMentorshipForWorker:
    post:
      operationId: createMentorshipForWorker
      summary: Workday Integration Create a mentorship for a worker
      description: >-
        Creates a mentorship relationship for the specified worker.
      tags:
        - Mentorships
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MentorshipForWorkerRequest'
      responses:
        '201':
          description: Mentorship created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Mentorship'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /mentorships/{ID}/close:
    post:
      operationId: closeMentorship
      summary: Workday Integration Close a mentorship
      description: >-
        Closes an active mentorship relationship.
      tags:
        - Mentorships
      parameters:
        - $ref: '#/components/parameters/ID'
      responses:
        '200':
          description: Mentorship closed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Mentorship'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /mentorships/{ID}/edit:
    post:
      operationId: editMentorship
      summary: Workday Integration Edit a mentorship
      description: >-
        Modifies an existing mentorship relationship.
      tags:
        - Mentorships
      parameters:
        - $ref: '#/components/parameters/ID'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MentorshipEditRequest'
      responses:
        '200':
          description: Mentorship updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Mentorship'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /talentPools:
    get:
      operationId: getTalentPools
      summary: Workday Integration Retrieve talent pools
      description: >-
        Returns a collection of talent pools for succession planning.
      tags:
        - Talent Pools
      parameters:
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: Successful response with talent pools
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TalentPoolsResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://{baseUrl}/authorize
          tokenUrl: https://{baseUrl}/oauth2/{tenant}/token
          scopes:
            r:talent: Read talent data
            w:talent: Write talent data
  parameters:
    ID:
      name: ID
      in: path
      required: true
      schema:
        type: string
    limit:
      name: limit
      in: query
      schema:
        type: integer
        default: 20
        maximum: 100
    offset:
      name: offset
      in: query
      schema:
        type: integer
        default: 0
  responses:
    BadRequest:
      description: Invalid request parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    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'
  schemas:
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
    ResourceReference:
      type: object
      properties:
        id:
          type: string
        descriptor:
          type: string
        href:
          type: string
          format: uri
    Mentorship:
      type: object
      properties:
        id:
          type: string
        descriptor:
          type: string
        mentor:
          $ref: '#/components/schemas/ResourceReference'
        mentee:
          $ref: '#/components/schemas/ResourceReference'
        status:
          type: string
        startDate:
          type: string
          format: date
        endDate:
          type: string
          format: date
    MentorshipsResponse:
      type: object
      properties:
        total:
          type: integer
        data:
          type: array
          items:
            $ref: '#/components/schemas/Mentorship'
    MentorshipRequest:
      type: object
      required:
        - mentor
      properties:
        mentor:
          $ref: '#/components/schemas/ResourceReference'
        topic:
          type: string
    MentorshipForWorkerRequest:
      type: object
      required:
        - mentor
        - mentee
      properties:
        mentor:
          $ref: '#/components/schemas/ResourceReference'
        mentee:
          $ref: '#/components/schemas/ResourceReference'
        topic:
          type: string
    MentorshipEditRequest:
      type: object
      properties:
        topic:
          type: string
        endDate:
          type: string
          format: date
    TalentPoolsResponse:
      type: object
      properties:
        total:
          type: integer
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              descriptor:
                type: string
              name:
                type: string
              owner:
                $ref: '#/components/schemas/ResourceReference'
tags:
  - name: Mentorships
  - name: Talent Pools