Deputy Rosters API

openapi: 3.2.0
info:
  title: Deputy Rosters API
  contact: {}
  version: '1.0'
servers:
- url: https://{install}.{geo}.deputy.com/api
  variables:
    install:
      default: ''
    geo:
      default: ''
security:
- httpBearer: []
tags:
- name: Rosters
paths:
  /v1/supervise/roster:
    get:
      tags:
      - Rosters
      summary: Get a list of rosters from last 12 hours, and forward 36hours
      description: Get a list of rosters from last 12 hours, and forward 36 hours
      operationId: Getalistofrostersfromlast12hours,andforward36hours
      parameters: []
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
      deprecated: false
  /v1/supervise/roster/autobuild:
    get:
      tags:
      - Rosters
      summary: Get rosters available for swap
      operationId: Getrostersavailableforswap
      parameters: []
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
      deprecated: false
  /v1/supervise/roster/copy:
    post:
      tags:
      - Rosters
      summary: Copy a Roster
      operationId: CopyaRoster
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CopyaRosterRequest'
              - example:
                  strFromDate: '2022-07-25T00:00:00.000Z'
                  strToDate: '2022-07-28T00:00:00.000Z'
                  intOperationalUnitArray:
                  - 400
                  blnRequireErrorDetails: 1
            example:
              strFromDate: '2022-07-25T00:00:00.000Z'
              strToDate: '2022-07-28T00:00:00.000Z'
              intOperationalUnitArray:
              - 400
              blnRequireErrorDetails: 1
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
      deprecated: false
  /v1/supervise/roster/discard:
    post:
      tags:
      - Rosters
      summary: Discard a roster
      operationId: Discardaroster
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/DiscardarosterRequest'
              - example:
                  intRosterArray:
                  - 400
            example:
              intRosterArray:
              - 400
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
      deprecated: false
  /v1/supervise/roster/publish:
    post:
      tags:
      - Rosters
      summary: Publish a roster
      operationId: Publisharoster
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PublisharosterRequest'
              - example:
                  intMode: 1
                  blnAllLocationsMode: 1
                  intRosterArray:
                  - 400
            example:
              intMode: 1
              blnAllLocationsMode: 1
              intRosterArray:
              - 400
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
      deprecated: false
components:
  schemas:
    CopyaRosterRequest:
      title: CopyaRosterRequest
      required:
      - strFromDate
      - strToDate
      - intOperationalUnitArray
      type: object
      properties:
        strFromDate:
          type: string
          description: Start date of roster in format YYYY-MM-DD
        strToDate:
          type: string
          description: End date of roster in format YYYY-MM-DD
        intOperationalUnitArray:
          type: array
          items:
            type: integer
            format: int32
        blnRequireErrorDetails:
          type: integer
          format: int32
          description: Require error details or not. 0 - No, 1 - Yes
    DiscardarosterRequest:
      title: DiscardarosterRequest
      required:
      - intRosterArray
      type: object
      properties:
        intRosterArray:
          type: array
          items:
            type: integer
            format: int32
          description: Array of the roster id records to discard as part of this request
    PublisharosterRequest:
      title: PublisharosterRequest
      required:
      - intMode
      - blnAllLocationsMode
      - intRosterArray
      type: object
      properties:
        intMode:
          type: integer
          format: int32
        blnAllLocationsMode:
          type: integer
          format: int32
          description: Whether to publish all locations rosters with this request. 0 - No, 1 - Yes
        intRosterArray:
          type: array
          items:
            type: integer
            format: int32
          description: Array of roster ids to be published with this request
  securitySchemes:
    httpBearer:
      type: http
      scheme: bearer
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