openapi: 3.2.0
info:
  title: Deputy V1 My Setup API
  version: 1.0.0
  description: 'Generated reference for Deputy''s legacy V1 `/supervise/` (supervisor-level operations) and `/my/` (authenticated-employee operations) endpoints.


    Enumerated statically from router classes under `deputy-webapp/app/api/v1/routers/Super*Router.php` and `My*Router.php`. V1 is in maintenance mode — new integrations should prefer V2.


    This spec covers only the `/my/*` routes. The sibling family is in a separate ReadMe spec.'
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
security:
- BearerAuth: []
tags:
- name: Setup
  description: V1 /my/setup/* endpoints
paths:
  /my/setup:
    get:
      tags:
      - Setup
      summary: List or get Setup
      operationId: my_setup__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
  /my/setup/addNewWorkplace:
    post:
      tags:
      - Setup
      summary: POST Setup / addNewWorkplace
      operationId: my_setup__addnewworkplace_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
  /my/setup/apps:
    get:
      tags:
      - Setup
      summary: GET Setup / apps
      operationId: my_setup__apps_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
  /my/setup/gamingfy/{action}:
    get:
      tags:
      - Setup
      summary: GET Setup / :action
      operationId: my_setup__gamingfy_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: action
        in: path
        required: true
        schema:
          type: string
          pattern: (list|decline)
    post:
      tags:
      - Setup
      summary: POST Setup / :action
      operationId: my_setup__gamingfy_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: action
        in: path
        required: true
        schema:
          type: string
          pattern: (list|decline)
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
  /my/setup/getAddressTimezoneFromGeo:
    post:
      tags:
      - Setup
      summary: POST Setup / getAddressTimezoneFromGeo
      operationId: my_setup__getaddresstimezonefromgeo_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
  /my/setup/getGeoTimezoneFromAddress:
    post:
      tags:
      - Setup
      summary: POST Setup / getGeoTimezoneFromAddress
      operationId: my_setup__getgeotimezonefromaddress_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
  /my/setup/getStateCountryList:
    get:
      tags:
      - Setup
      summary: GET Setup / getStateCountryList
      operationId: my_setup__getstatecountrylist_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
  /my/setup/sendEmailToCX:
    post:
      tags:
      - Setup
      summary: POST Setup / sendEmailToCX
      operationId: my_setup__sendemailtocx_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
  /my/setup/sf:
    post:
      tags:
      - Setup
      summary: POST Setup / sf
      operationId: my_setup__sf_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
  /my/setup/supportAccess:
    get:
      tags:
      - Setup
      summary: GET Setup / supportAccess
      operationId: my_setup__supportaccess_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
  /my/setup/validateWorkplace:
    post:
      tags:
      - Setup
      summary: POST Setup / validateWorkplace
      operationId: my_setup__validateworkplace_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
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: OAuth 2.0 access token or Deputy Permanent Token.