openapi: 3.2.0
info:
  title: Deputy Employee API
  version: 1.0.0
  description: 'Operations tagged Employee across 2 of this provider''s published API definitions: deputy-v1-resource-api-openapi.yml, deputy-v1-supervise-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{subdomain}.{region}.deputy.com/api/v1
  description: Deputy tenant
  variables:
    subdomain:
      default: your-subdomain
    region:
      default: deputy
      enum:
      - au
      - eu
      - na
      - deputy
tags:
- name: Employee
  description: Operations on the Employee resource
paths:
  /resource/Employee:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    get:
      tags:
      - Employee
      summary: List Employee records
      description: Returns Employee records the authenticated caller is permitted to see. For large tables prefer POST /QUERY with pagination.
      operationId: listEmployee
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Employee'
        '400':
          description: Bad request
        '401':
          description: Authentication required or invalid token
        '403':
          description: Forbidden — token lacks access to this resource
        '404':
          description: Resource not found
      security:
      - BearerAuth: []
      - OAuth2: []
    post:
      tags:
      - Employee
      summary: Create a Employee
      operationId: createEmployee
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Employee'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Employee'
        '400':
          description: Bad request
        '401':
          description: Authentication required or invalid token
        '403':
          description: Forbidden — token lacks access to this resource
        '404':
          description: Resource not found
      security:
      - BearerAuth: []
      - OAuth2: []
    put:
      tags:
      - Employee
      summary: Create a Employee
      operationId: createOrReplaceEmployee
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Employee'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Employee'
        '400':
          description: Bad request
        '401':
          description: Authentication required or invalid token
        '403':
          description: Forbidden — token lacks access to this resource
        '404':
          description: Resource not found
      security:
      - BearerAuth: []
      - OAuth2: []
  /resource/Employee/BULK:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    post:
      tags:
      - Employee
      summary: Bulk create/update Employee
      description: Accepts an array of records. Each record is processed independently.
      operationId: bulkEmployee
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Employee'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Employee'
        '400':
          description: Bad request
        '401':
          description: Authentication required or invalid token
        '403':
          description: Forbidden — token lacks access to this resource
        '404':
          description: Resource not found
      security:
      - BearerAuth: []
      - OAuth2: []
  /resource/Employee/INFO:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    get:
      tags:
      - Employee
      summary: Get field metadata for Employee
      description: Returns the field list, types, and associations for this resource. Useful when building integrations that need to know which fields are queryable.
      operationId: infoEmployee
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Authentication required or invalid token
        '403':
          description: Forbidden — token lacks access to this resource
        '404':
          description: Resource not found
      security:
      - BearerAuth: []
      - OAuth2: []
  /resource/Employee/PREDICT:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    post:
      tags:
      - Employee
      summary: Predict-match a Employee record
      description: Returns the closest matching existing record for a partial payload. Used by upsert-style integrations to find an existing row before creating.
      operationId: predictEmployee
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Employee'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Employee'
        '400':
          description: Bad request
        '401':
          description: Authentication required or invalid token
        '403':
          description: Forbidden — token lacks access to this resource
        '404':
          description: Resource not found
      security:
      - BearerAuth: []
      - OAuth2: []
  /resource/Employee/QUERY:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    post:
      tags:
      - Employee
      summary: Search Employee
      description: 'Flexible search endpoint. Body supports `search`, `sort`, `start`, `max`, and `join` clauses. Example: `{"search": {"s1": {"field": "Id", "data": 1, "type": "eq"}}}`.'
      operationId: searchEmployee
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Employee'
        '400':
          description: Bad request
        '401':
          description: Authentication required or invalid token
        '403':
          description: Forbidden — token lacks access to this resource
        '404':
          description: Resource not found
      security:
      - BearerAuth: []
      - OAuth2: []
  /resource/Employee/{id}:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    get:
      tags:
      - Employee
      summary: Get a Employee by id
      operationId: getEmployeeById
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
        description: Numeric id of the resource
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Employee'
        '400':
          description: Bad request
        '401':
          description: Authentication required or invalid token
        '403':
          description: Forbidden — token lacks access to this resource
        '404':
          description: Resource not found
      security:
      - BearerAuth: []
      - OAuth2: []
    post:
      tags:
      - Employee
      summary: Update a Employee
      operationId: updateEmployee
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
        description: Numeric id of the resource
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Employee'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Employee'
        '400':
          description: Bad request
        '401':
          description: Authentication required or invalid token
        '403':
          description: Forbidden — token lacks access to this resource
        '404':
          description: Resource not found
      security:
      - BearerAuth: []
      - OAuth2: []
    put:
      tags:
      - Employee
      summary: Update a Employee
      operationId: replaceEmployee
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
        description: Numeric id of the resource
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Employee'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Employee'
        '400':
          description: Bad request
        '401':
          description: Authentication required or invalid token
        '403':
          description: Forbidden — token lacks access to this resource
        '404':
          description: Resource not found
      security:
      - BearerAuth: []
      - OAuth2: []
    delete:
      tags:
      - Employee
      summary: Delete a Employee
      operationId: deleteEmployee
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
        description: Numeric id of the resource
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
        '400':
          description: Bad request
        '401':
          description: Authentication required or invalid token
        '403':
          description: Forbidden — token lacks access to this resource
        '404':
          description: Resource not found
      security:
      - BearerAuth: []
      - OAuth2: []
  /resource/Employee/{id}/COMMENTS:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    get:
      tags:
      - Employee
      summary: List comments on a Employee
      operationId: getCommentsEmployee
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
        description: Numeric id of the resource
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    Id:
                      type: integer
                    Comment:
                      type: string
                    Creator:
                      type: integer
                    Created:
                      type: string
                      format: date-time
        '400':
          description: Bad request
        '401':
          description: Authentication required or invalid token
        '403':
          description: Forbidden — token lacks access to this resource
        '404':
          description: Resource not found
      security:
      - BearerAuth: []
      - OAuth2: []
    post:
      tags:
      - Employee
      summary: Add a comment to a Employee
      operationId: addCommentEmployee
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
        description: Numeric id of the resource
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                Comment:
                  type: string
              required:
              - Comment
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Authentication required or invalid token
        '403':
          description: Forbidden — token lacks access to this resource
        '404':
          description: Resource not found
      security:
      - BearerAuth: []
      - OAuth2: []
  /resource/Employee/{id}/COMMENTS/{commentId}:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    delete:
      tags:
      - Employee
      summary: Delete a comment on a Employee
      operationId: deleteCommentEmployee
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
        description: Numeric id of the resource
      - name: commentId
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
        '400':
          description: Bad request
        '401':
          description: Authentication required or invalid token
        '403':
          description: Forbidden — token lacks access to this resource
        '404':
          description: Resource not found
      security:
      - BearerAuth: []
      - OAuth2: []
  /resource/Employee/{id}/HISTORY:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    get:
      tags:
      - Employee
      summary: Get change history for a Employee
      operationId: historyEmployee
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
        description: Numeric id of the resource
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Employee'
        '400':
          description: Bad request
        '401':
          description: Authentication required or invalid token
        '403':
          description: Forbidden — token lacks access to this resource
        '404':
          description: Resource not found
      security:
      - BearerAuth: []
      - OAuth2: []
  /resource/Employee/{id}/HISTORY/travel/{timestamp}:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    get:
      tags:
      - Employee
      summary: Get a Employee as it existed at a prior time
      operationId: historyEmployeeTravel
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
        description: Numeric id of the resource
      - name: timestamp
        in: path
        required: true
        schema:
          type: integer
          format: int64
        description: Unix epoch seconds
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Employee'
        '400':
          description: Bad request
        '401':
          description: Authentication required or invalid token
        '403':
          description: Forbidden — token lacks access to this resource
        '404':
          description: Resource not found
      security:
      - BearerAuth: []
      - OAuth2: []
  /supervise/employee:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    put:
      tags:
      - Employee
      summary: Create Employee
      operationId: supervise_employee__put
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
    post:
      tags:
      - Employee
      summary: Create or update Employee
      operationId: supervise_employee__post
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
  /supervise/employee/QUERY:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    post:
      tags:
      - Employee
      summary: POST Employee / QUERY
      operationId: supervise_employee__query_post
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
  /supervise/employee/amendABP:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    post:
      tags:
      - Employee
      summary: POST Employee / amendABP
      operationId: supervise_employee__amendabp_post
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
  /supervise/employee/checkLicense:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    post:
      tags:
      - Employee
      summary: POST Employee / checkLicense
      operationId: supervise_employee__checklicense_post
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
  /supervise/employee/contractedhours/template:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    get:
      tags:
      - Employee
      summary: GET Employee / template
      operationId: supervise_employee__contractedhours_template_get
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      security:
      - BearerAuth: []
    put:
      tags:
      - Employee
      summary: PUT Employee / template
      operationId: supervise_employee__contractedhours_template_put
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
    post:
      tags:
      - Employee
      summary: POST Employee / template
      operationId: supervise_employee__contractedhours_template_post
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
  /supervise/employee/contractedhours/template/{templateId}:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    post:
      tags:
      - Employee
      summary: POST Employee / :templateId
      operationId: supervise_employee__contractedhours_template_templateid_post
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: templateId
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
    delete:
      tags:
      - Employee
      summary: DELETE Employee / :templateId
      operationId: supervise_employee__contractedhours_template_templateid_delete
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: templateId
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      security:
      - BearerAuth: []
  /supervise/employee/create:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    put:
      tags:
      - Employee
      summary: PUT Employee / create
      operationId: supervise_employee__create_put
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
    post:
      tags:
      - Employee
      summary: POST Employee / create
      operationId: supervise_employee__create_post
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
  /supervise/employee/demo:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    get:
      tags:
      - Employee
      summary: GET Employee / demo
      operationId: supervise_employee__demo_get
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      security:
      - BearerAuth: []
  /supervise/employee/invitation:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    get:
      tags:
      - Employee
      summary: GET Employee / invitation
      operationId: supervise_employee__invitation_get
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      security:
      - BearerAuth: []
    post:
      tags:
      - Employee
      summary: POST Employee / invitation
      operationId: supervise_employee__invitation_post
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
    delete:
      tags:
      - Employee
      summary: DELETE Employee / invitation
      operationId: supervise_employee__invitation_delete
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      security:
      - BearerAuth: []
  /supervise/employee/invitation/validate:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    post:
      tags:
      - Employee
      summary: POST Employee / validate
      operationId: supervise_employee__invitation_validate_post
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
  /supervise/employee/real:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    get:
      tags:
      - Employee
      summary: GET Employee / real
      operationId: supervise_employee__real_get
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      security:
      - BearerAuth: []
  /supervise/employee/real/count:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    get:
      tags:
      - Employee
      summary: GET Employee / count
      operationId: supervise_employee__real_count_get
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      security:
      - BearerAuth: []
  /supervise/employee/reset/gender:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    post:
      tags:
      - Employee
      summary: POST Employee / gender
      operationId: supervise_employee__reset_gender_post
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
  /supervise/employee/role/manage:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    get:
      tags:
      - Employee
      summary: GET Employee / manage
      operationId: supervise_employee__role_manage_get
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      security:
      - BearerAuth: []
  /supervise/employee/validate:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    put:
      tags:
      - Employee
      summary: PUT Employee / validate
      operationId: supervise_employee__validate_put
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
    post:
      tags:
      - Employee
      summary: POST Employee / validate
      operationId: supervise_employee__validate_post
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
  /supervise/employee/{employeeId}:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    get:
      tags:
      - Employee
      summary: GET Employee / (:employeeId)?
      operationId: supervise_employee__employeeid__get
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: employeeId
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      security:
      - BearerAuth: []
    post:
      tags:
      - Employee
      summary: POST Employee / :employeeId
      operationId: supervise_employee__employeeid_post
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: employeeId
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
  /supervise/employee/{employeeId}/activate:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    post:
      tags:
      - Employee
      summary: POST Employee / activate
      operationId: supervise_employee__employeeid_activate_post
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: employeeId
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
  /supervise/employee/{employeeId}/assoc/{wpId}:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    post:
      tags:
      - Employee
      summary: POST Employee / :wpId
      operationId: supervise_employee__employeeid_assoc_wpid_post
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: employeeId
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      - name: wpId
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
  /supervise/employee/{employeeId}/contractedhours:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    get:
      tags:
      - Employee
      summary: GET Employee / contractedhours
      operationId: supervise_employee__employeeid_contractedhours_get
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: employeeId
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      security:
      - BearerAuth: []
    put:
      tags:
      - Employee
      summary: PUT Employee / contractedhours
      operationId: supervise_employee__employeeid_contractedhours_put
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: employeeId
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
    post:
      tags:
      - Employee
      summary: POST Employee / contractedhours
      operationId: supervise_employee__employeeid_contractedhours_post
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: employeeId
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
  /supervise/employee/{employeeId}/delete:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    post:
      tags:
      - Employee
      summary: POST Employee / delete
      operationId: supervise_employee__employeeid_delete_post
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: employeeId
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
  /supervise/employee/{employeeId}/hr/onboarding:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    get:
      tags:
      - Employee
      summary: GET Employee / onboarding
      operationId: supervise_employee__employeeid_hr_onboarding_get
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: employeeId
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      security:
      - BearerAuth: []
    post:
      tags:
      - Employee
      summary: POST Employee / onboarding
      operationId: supervise_employee__employeeid_hr_onboarding_post
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: employeeId
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
  /supervise/employee/{employeeId}/hr/payroll/connected:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    get:
      tags:
      - Employee
      summary: GET Employee / connected
      operationId: supervise_employee__employeeid_hr_payroll_connected_get
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: employeeId
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      security:
      - BearerAuth: []
  /supervise/employee/{employeeId}/hr/payroll/sync:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    get:
      tags:
      - Employee
      summary: GET Employee / sync
      operationId: supervise_employee__employeeid_hr_payroll_sync_get
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: employeeId
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      security:
      - BearerAuth: []
    post:
      tags:
      - Employee
      summary: POST Employee / sync
      operationId: supervise_employee__employeeid_hr_payroll_sync_post
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: employeeId
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
  /supervise/employee/{employeeId}/invite:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    post:
      tags:
      - Employee
      summary: POST Employee / invite
      operationId: supervise_employee__employeeid_invite_post
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: employeeId
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
  /supervise/employee/{employeeId}/manage-login:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    get:
      tags:
      - Employee
      summary: GET Employee / manage login
      operationId: supervise_employee__employeeid_manage_login_get
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: employeeId
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      security:
      - BearerAuth: []
  /supervise/employee/{employeeId}/photo:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    post:
      tags:
      - Employee
      summary: POST Employee / photo
      operationId: supervise_employee__employeeid_photo_post
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: employeeId
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
  /supervise/employee/{employeeId}/reset-2fa:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    post:
      tags:
      - Employee
      summary: POST Employee / reset 2fa
      operationId: supervise_employee__employeeid_reset_2fa_post
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: employeeId
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
  /supervise/employee/{employeeId}/send-reset-account:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    post:
      tags:
      - Employee
      summary: POST Employee / send reset account
      operationId: supervise_employee__employeeid_send_reset_account_post
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: employeeId
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
  /supervise/employee/{employeeId}/sendlogin:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    post:
      tags:
      - Employee
      summary: POST Employee / sendlogin
      operationId: supervise_employee__employeeid_sendlogin_post
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: employeeId
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
  /supervise/employee/{employeeId}/setAwardFromLibrary:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    post:
      tags:
      - Employee
      summary: POST Employee / setAwardFromLibrary
      operationId: supervise_employee__employeeid_setawardfromlibrary_post
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: employeeId
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
  /supervise/employee/{employeeId}/setAwardFromTemplate:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    post:
      tags:
      - Employee
      summary: POST Employee / setAwardFromTemplate
      operationId: supervise_employee__employeeid_setawardfromtemplate_post
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: employeeId
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
  /supervise/employee/{employeeId}/terminate:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    post:
      tags:
      - Employee
      summary: POST Employee / terminate
      operationId: supervise_employee__employeeid_terminate_post
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: employeeId
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
  /supervise/employee/{employeeId}/unassoc/{wpId}:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    post:
      tags:
      - Employee
      summary: POST Employee / :wpId
      operationId: supervise_employee__employeeid_unassoc_wpid_post
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: employeeId
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      - name: wpId
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
  /supervise/employee/{employeeId}/validate:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    get:
      tags:
      - Employee
      summary: GET Employee / validate
      operationId: supervise_employee__employeeid_validate_get
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: employeeId
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      security:
      - BearerAuth: []
  /supervise/employee/{employeeId}/{action}:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    post:
      tags:
      - Employee
      summary: POST Employee / :action
      operationId: supervise_employee__employeeid_action_post
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: employeeId
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      - name: action
        in: path
        required: true
        schema:
          type: string
          pattern: (Memo|Roster|Timesheet|Journal|Leave|EmployeeAvailability)
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
    get:
      tags:
      - Employee
      summary: GET Employee / :action
      operationId: supervise_employee__employeeid_action_get
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: employeeId
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      - name: action
        in: path
        required: true
        schema:
          type: string
          pattern: (Memo|Roster|Timesheet|Journal|Leave|EmployeeAvailability)
      security:
      - BearerAuth: []
components:
  schemas:
    Employee:
      type: object
      properties:
        Id:
          type: integer
        Company:
          type: integer
        FirstName:
          type: string
          maxLength: 64
        LastName:
          type: string
          maxLength: 64
        DisplayName:
          type: string
          maxLength: 255
        OtherName:
          type: string
          maxLength: 64
        Salutation:
          type: string
          maxLength: 32
        MainAddress:
          type: integer
        PostalAddress:
          type: integer
        Contact:
          type: integer
        EmergencyAddress:
          type: integer
        DateOfBirth:
          type: string
          format: date-time
        Gender:
          type: integer
        Pronouns:
          type: integer
        CustomPronouns:
          type: string
          maxLength: 64
        Photo:
          type: integer
        UserId:
          type: integer
        JobAppId:
          type: integer
        Active:
          type: boolean
        StartDate:
          type: string
          format: date-time
        TerminationDate:
          type: string
          format: date-time
        EmploymentEndDate:
          type: string
          format: date-time
        EmploymentEndReason:
          type: string
        EmploymentEndSentiment:
          type: string
        EmploymentEndComment:
          type: string
          maxLength: 255
        StressProfile:
          type: integer
        Position:
          type: string
          maxLength: 255
        HigherDuty:
          type: boolean
        Role:
          type: integer
        AllowAppraisal:
          type: boolean
        HistoryId:
          type: integer
        CustomFieldData:
          type: integer
        OnboardingId:
          type: string
          maxLength: 64
        ExternalLinkId:
          type: string
          maxLength: 64
        Creator:
          type: integer
        Created:
          type: string
          format: date-time
        Modified:
          type: string
        CompanyObject:
          type: object
        MainAddressObject:
          type: object
        PostalAddressObject:
          type: object
        ContactObject:
          type: object
        EmergencyAddressObject:
          type: object
        PhotoObject:
          type: object
        User:
          type: object
        JobApp:
          type: object
        StressProfileObject:
          type: object
        RoleObject:
          type: object
        CustomFieldDataObject:
          type: object
        DirtyDeputecUserAsEmployeeProfile:
          type: boolean
      required:
      - Id
      - Company
      - FirstName
      - LastName
      - DisplayName
      - Contact
      - Active
      - Role
      - AllowAppraisal
      - Modified
    QueryRequest:
      type: object
      description: V1 Resource search payload. All fields optional; an empty body returns the first page of results.
      properties:
        search:
          type: object
          description: Map of search clauses keyed by an arbitrary id (e.g. `s1`, `s2`). Each clause filters one field.
          additionalProperties:
            type: object
            required:
            - field
            - data
            - type
            properties:
              field:
                type: string
                description: Field name to filter on (e.g. `Id`, `Employee`).
              data:
                description: Comparison value. Type depends on the field.
              type:
                type: string
                description: Comparison operator.
                enum:
                - eq
                - ne
                - gt
                - lt
                - ge
                - le
                - is
                - is not
                - in
                - not in
                - starts
                - contains
        sort:
          type: object
          description: Map of field name → `asc` or `desc`.
          additionalProperties:
            type: string
            enum:
            - asc
            - desc
        start:
          type: integer
          minimum: 0
          default: 0
          description: Pagination offset (0-indexed).
        max:
          type: integer
          minimum: 1
          maximum: 500
          default: 100
          description: Max records per page (server caps at 500).
        join:
          type: array
          items:
            type: string
          description: Related ORMs to expand inline (e.g. `["EmployeeObject"]`).
      example:
        search:
          s1:
            field: Id
            data: 1
            type: ge
        max: 100
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: OAuth 2.0 access token or Deputy Permanent Token.
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://once.deputy.com/my/oauth/login
          tokenUrl: https://once.deputy.com/my/oauth/access_token
          scopes:
            longlife_refresh_token: Extended session
x-refined-from:
- deputy-v1-resource-api-openapi.yml
- deputy-v1-supervise-api-openapi.yml
x-provenance:
  method: searched
  source: https://developer.deputy.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developer.deputy.com/reference/addalocation.md
  - https://developer.deputy.com/reference/addalocationagainstanemployee.md
  - https://developer.deputy.com/reference/addanemployee.md
  - https://developer.deputy.com/reference/addasaletosalesmetrics.md
  - https://developer.deputy.com/reference/addawebhookurl.md
  - https://developer.deputy.com/reference/addleaveforaemployee.md
  - https://developer.deputy.com/reference/addnewworkplace.md
  - https://developer.deputy.com/reference/addunavailabilitydetailsforaemployee.md
  - https://developer.deputy.com/reference/archivealocation.md
  - https://developer.deputy.com/reference/copyaroster.md
  - https://developer.deputy.com/reference/create-a-memo.md
  - https://developer.deputy.com/reference/createadepartment.md
  - https://developer.deputy.com/reference/createmultipledepartments.md
  - https://developer.deputy.com/reference/deletealocation.md
  - https://developer.deputy.com/reference/deleteanemployeesaccountindeputy.md
  - https://developer.deputy.com/reference/deleteasingleoperationalunit.md
  - https://developer.deputy.com/reference/discardaroster.md
  - https://developer.deputy.com/reference/doatask.md
  - https://developer.deputy.com/reference/example-searchforemployeesfromalocation.md
  - https://developer.deputy.com/reference/findanemployeesleave.md
  - https://developer.deputy.com/reference/findoutanemployeesstatus.md
  - https://developer.deputy.com/reference/getagreedhoursbyemployeeid.md
  - https://developer.deputy.com/reference/getalistofrostersfromlast12hoursandforward36hours.md
  - https://developer.deputy.com/reference/getalocationssettings.md
  - https://developer.deputy.com/reference/getawardslibrarylist.md
  - https://developer.deputy.com/reference/getdetailsforaemployeebyid.md
  - https://developer.deputy.com/reference/getdetailsforallemployees.md
  - https://developer.deputy.com/reference/getlocationbyid.md
  - https://developer.deputy.com/reference/getlocations.md
  - https://developer.deputy.com/reference/getmyindividualtimesheet.md
  - https://developer.deputy.com/reference/getmynewsfeed.md
  - https://developer.deputy.com/reference/getmynotifications.md
  - https://developer.deputy.com/reference/getmysubordinatecontactdetails.md
  - https://developer.deputy.com/reference/getmytasks.md
  - https://developer.deputy.com/reference/getmytimesheets.md
  - https://developer.deputy.com/reference/getmytraining.md
  - https://developer.deputy.com/reference/getoperationalunits.md
  - https://developer.deputy.com/reference/getrostersavailableforswap.md
  - https://developer.deputy.com/reference/getsimplifiedlocationlist.md
  - https://developer.deputy.com/reference/getsuggestionsforrosterbyid.md
  - https://developer.deputy.com/reference/getunavailabilitydetailsforaemployee.md
  - https://developer.deputy.com/reference/inviteemployeetodeputy.md
  - https://developer.deputy.com/reference/modifysettingsinalllocations.md
  - https://developer.deputy.com/reference/modifysettingsinasinglelocation.md
  - https://developer.deputy.com/reference/myaddressonfile.md
  - https://developer.deputy.com/reference/myaddressonfileincludingemergency.md
  - https://developer.deputy.com/reference/myleaverequests.md
  - https://developer.deputy.com/reference/pauseorunpauseemployeestimesheettakeabreakfinishbreak.md
  - https://developer.deputy.com/reference/postajournal.md
  - https://developer.deputy.com/reference/publisharoster.md
  - https://developer.deputy.com/reference/re-activateaterminatedemployee.md
  - https://developer.deputy.com/reference/removealocationfromanemployee.md
  - https://developer.deputy.com/reference/retrievecurrentsystemtime.md
  - https://developer.deputy.com/reference/retrievecurrentsystemtimeofalocation.md
  - https://developer.deputy.com/reference/retrievesalesdata.md
  - https://developer.deputy.com/reference/setawardforemployee.md
  - https://developer.deputy.com/reference/startanemployeestimesheetclockon.md
  - https://developer.deputy.com/reference/stopanemployeestimesheetclockoff.md
  - https://developer.deputy.com/reference/terminateanemployee.md
  - https://developer.deputy.com/reference/updatealocation.md
  - https://developer.deputy.com/reference/updateanexistingemployee.md
  - https://developer.deputy.com/reference/updateasingleoperationalunit.md
  - https://developer.deputy.com/reference/updatemyaddress.md
  - https://developer.deputy.com/reference/viewatimesheetbyid.md
  - https://developer.deputy.com/reference/whatlocationscaniworkin.md
  - https://developer.deputy.com/reference/whenaminextworking.md
  - https://developer.deputy.com/reference/whenamiunavailable.md
  - https://developer.deputy.com/reference/wherecaniworkwhatdoido.md
  - https://developer.deputy.com/reference/whodoiworkwith.md
  merge:
    pages: 69
    deduped: 70
    conflicts_kept_first: 0