Deputy Embedded Reports API

The Embedded Reports API from Deputy — 16 operation(s) for embedded reports.

Business capability
Analytics & BI Management BC-610.50

Operations 16

GET /management/v2/reports/embed List available Embedded reports #
GET /management/v2/reports/embed/classic List classic reports #
POST /management/v2/reports/embed/copy-workbook Copy an existing workbook #
POST /management/v2/reports/embed/create-workbook Create a new workbook #
POST /management/v2/reports/embed/downgrade-sigma-member-license:bulk Downgrade all Sigma team member licenses associated with a Deputy tenant #
POST /management/v2/reports/embed/generate-url Generate embed URL for a given workbook #
POST /management/v2/reports/embed/get-users-by-permission Get the list of users who has the given permission #
GET /management/v2/reports/embed/home-folder-workbooks List available workbooks under embed user home folder #
POST /management/v2/reports/embed/rename-workbook Rename home folder workbook #
POST /management/v2/reports/embed/share-workbook Create or update grants to the workbook #
POST /management/v2/reports/embed/tenant-onboarding Provision a Sigma Workspace and Team for a Deputy Tenant #
POST /management/v2/reports/embed/update-tenant Update tenant data on Sigma #
GET /management/v2/reports/embed/workbook/shared-with-me List all workbooks that have been shared with me #
DELETE /management/v2/reports/embed/workbook/{id} Delete a workbook #
GET /management/v2/reports/embed/workbook/{id}/shared-with List shared status of team and users #
POST /management/v2/reports/embed/workbook/{id}:remove-shared-access Remove shared access to the workbook #

Specifications

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-addanemployee-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-createa-department-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-addleaveforaemployee-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-createamemo-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-add-new-workplace-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-setawardforemployee-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-custom-field-data-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-timesheet-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-employee-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-pay-rules-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-roster-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-employee-agreement-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-tenanttimesheetv2model-timesheet-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-pay-comparison-submit-report-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-v2model-leave-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-v2model-employment-contracts-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-copy-request-copy-request-data-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-v2model-area-profile-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-searchfor-employment-contract-leave-rules-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-searchforan-employee-agreement-history-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-searchforan-employee-availability-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-searchforacustomfielddataentry-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-searchforan-employment-condition-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-searchforan-employment-contract-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-hr-export-export-hr-bulk-data-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-user-info-get-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-hr-export-export-hr-data-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-hr-export-export-hr-pay-details-data-response-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/deputy:deputy-embedded-reports-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

deputy-embedded-reports-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Deputy V2 Embedded Reports API
  version: '1.0'
  description: Filtered to publicly-authenticated routes only (APIAuthenticator). Scoped-OAuth routes and internal JWT routes are excluded — see the separate "Deputy V2 Scoped API" spec for scoped endpoints.
servers:
- url: https://{subdomain}.{region}.deputy.com/api
  description: Deputy tenant
  variables:
    subdomain:
      default: your-subdomain
      description: Your Deputy tenant subdomain
    region:
      default: deputy
      enum:
      - au
      - eu
      - na
      - deputy
      description: 'Deputy region: au, eu, na, or deputy (AU default)'
security:
- ApiToken: []
tags:
- name: Embedded Reports
paths:
  /management/v2/reports/embed:
    get:
      summary: List available Embedded reports
      operationId: EmbeddedReportsV2Controller_list
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddedReportsListResponse'
      parameters:
      - name: filters
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      - name: op
        in: query
        required: false
        schema:
          type: string
      - name: cursor
        in: query
        required: false
        schema:
          type: string
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          format: int32
      tags:
      - Embedded Reports
      description: List available Embedded reports.
  /management/v2/reports/embed/classic:
    get:
      operationId: EmbeddedReportsV2Controller_listClassicReports
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddedReportsListClassicReportsResponse'
      parameters:
      - name: filters
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      - name: op
        in: query
        required: false
        schema:
          type: string
      - name: cursor
        in: query
        required: false
        schema:
          type: string
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          format: int32
      tags:
      - Embedded Reports
      summary: List classic reports
      description: List classic reports.
  /management/v2/reports/embed/copy-workbook:
    post:
      summary: Copy an existing workbook
      operationId: EmbeddedReportsV2Controller_copyWorkbook
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddedReportsCopyWorkbookResponse'
      tags:
      - Embedded Reports
      description: Copy an existing workbook.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmbeddedReportsCopyWorkbookRequest'
  /management/v2/reports/embed/create-workbook:
    post:
      summary: Create a new workbook
      operationId: EmbeddedReportsV2Controller_createWorkbook
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddedReportsCreateWorkbookResponse'
      tags:
      - Embedded Reports
      description: Create a new workbook.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmbeddedReportsCreateWorkbookRequest'
  /management/v2/reports/embed/downgrade-sigma-member-license:bulk:
    post:
      summary: Downgrade all Sigma team member licenses associated with a Deputy tenant
      operationId: EmbeddedReportsV2Controller_downgradeSigmaMemberLicenseBulk
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddedReportsDowngradeSigmaMemberLicenseBulkResponse'
      tags:
      - Embedded Reports
      description: Downgrade all Sigma team member licenses associated with a Deputy tenant.
  /management/v2/reports/embed/generate-url:
    post:
      summary: Generate embed URL for a given workbook
      operationId: EmbeddedReportsV2Controller_generateEmbedUrlForWorkbook
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddedReportsGenerateURLResponse'
      tags:
      - Embedded Reports
      description: Generate embed URL for a given workbook.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmbeddedReportsGenerateURLRequest'
  /management/v2/reports/embed/get-users-by-permission:
    post:
      summary: Get the list of users who has the given permission
      operationId: EmbeddedReportsV2Controller_getUsersByPermission
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddedReportsGetUsersByPermissionResponse'
      tags:
      - Embedded Reports
      description: Get the list of users who has the given permission.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmbeddedReportsGetUsersByPermissionRequest'
  /management/v2/reports/embed/home-folder-workbooks:
    get:
      summary: List available workbooks under embed user home folder
      operationId: EmbeddedReportsV2Controller_listHomeFolderWorkbooks
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddedReportsListHomeFolderWorkbooksResponse'
      parameters:
      - name: filters
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      - name: op
        in: query
        required: false
        schema:
          type: string
      - name: cursor
        in: query
        required: false
        schema:
          type: string
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          format: int32
      tags:
      - Embedded Reports
      description: List available workbooks under embed user home folder.
  /management/v2/reports/embed/rename-workbook:
    post:
      summary: Rename home folder workbook
      operationId: EmbeddedReportsV2Controller_renameHomeFolderWorkbook
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddedReportsRenameHomeFolderWorkbookResponse'
      tags:
      - Embedded Reports
      description: Rename home folder workbook.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmbeddedReportsRenameHomeFolderWorkbookRequest'
  /management/v2/reports/embed/share-workbook:
    post:
      summary: Create or update grants to the workbook
      operationId: EmbeddedReportsV2Controller_shareWorkbook
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddedReportsShareWorkbookResponse'
      tags:
      - Embedded Reports
      description: Create or update grants to the workbook.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmbeddedReportsShareWorkbookRequest'
  /management/v2/reports/embed/tenant-onboarding:
    post:
      summary: Provision a Sigma Workspace and Team for a Deputy Tenant
      operationId: EmbeddedReportsV2Controller_provisionTenantOnSigma
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddedReportsProvisionTenantToSigmaResponse'
      tags:
      - Embedded Reports
      description: Provision a Sigma Workspace and Team for a Deputy Tenant.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/modelSigmaTenantData'
  /management/v2/reports/embed/update-tenant:
    post:
      summary: Update tenant data on Sigma
      operationId: EmbeddedReportsV2Controller_updateTenantDataOnSigma
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddedReportsUpdateTenantDataOnSigmaResponse'
      tags:
      - Embedded Reports
      description: Update tenant data on Sigma.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmbeddedReportsUpdateTenantDataOnSigmaRequest'
  /management/v2/reports/embed/workbook/shared-with-me:
    get:
      summary: List all workbooks that have been shared with me
      operationId: EmbeddedReportsV2Controller_listSharedWithMeWorkbooks
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddedReportsListSharedWithMeWorkbooksResponse'
      parameters:
      - name: filters
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      - name: op
        in: query
        required: false
        schema:
          type: string
      - name: cursor
        in: query
        required: false
        schema:
          type: string
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          format: int32
      tags:
      - Embedded Reports
      description: List all workbooks that have been shared with me.
  /management/v2/reports/embed/workbook/{id}:
    delete:
      summary: Delete a workbook
      operationId: EmbeddedReportsV2Controller_deleteWorkbook
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddedReportsDeleteWorkbookResponse'
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      tags:
      - Embedded Reports
      description: Delete a workbook.
  /management/v2/reports/embed/workbook/{id}/shared-with:
    get:
      summary: List shared status of team and users
      operationId: EmbeddedReportsV2Controller_listSharedWithStatus
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddedReportsListSharedWithStatusResponse'
      parameters:
      - name: id
        description: Workbook ID
        in: path
        required: true
        schema:
          type: string
      tags:
      - Embedded Reports
      description: List shared status of team and users.
  /management/v2/reports/embed/workbook/{id}:remove-shared-access:
    post:
      summary: Remove shared access to the workbook
      operationId: EmbeddedReportsV2Controller_removeSharedWorkbookAccess
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddedReportsRemoveSharedWorkbookAccessResponse'
      parameters:
      - name: id
        description: Workbook ID
        in: path
        required: true
        schema:
          type: string
      tags:
      - Embedded Reports
      description: Remove shared access to the workbook.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmbeddedReportsRemoveSharedWorkbookAccessRequest'
components:
  schemas:
    modelClassicReports:
      type: object
      properties:
        id:
          type: integer
          format: int32
          title: DB primary key - required for report execution
        deputecId:
          type: string
          title: Business identifier - required for routing
        name:
          type: string
          title: Reports name
    EmbeddedReportsRenameHomeFolderWorkbookResponse:
      type: object
      properties:
        success:
          type: boolean
    EmbeddedReportsShareWorkbookResponse:
      type: object
      properties:
        success:
          type: boolean
    EmbeddedReportsListResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: array
          items:
            $ref: '#/components/schemas/v2modelData'
    EmbeddedReportsCopyWorkbookRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/modelCopyWorkbookRequestData'
    modelCopyWorkbookResponseData:
      type: object
      properties:
        workbookId:
          type: string
          title: The workbook ID
        workbookUrlId:
          type: string
          title: The workbook's URL ID
        name:
          type: string
          title: The workbook name
    modelEmbedPayload:
      type: object
      properties:
        workbookId:
          type: string
          title: Workbook ID
        workbookUrlId:
          type: string
          title: Workbook URL ID
        action:
          type: string
          title: Report action (view, edit, etc)
        isCustomWorkbook:
          type: boolean
          title: Identifies if the workbook is custom workbook
    EmbeddedReportsDowngradeSigmaMemberLicenseBulkResponse:
      type: object
      properties:
        success:
          type: boolean
    modelRemoveSharedWorkbookAccessRequestData:
      type: object
      properties:
        userUuid:
          type: string
          title: Deputy user UUID
        removeTeamAccess:
          type: boolean
          title: If this request is for removing team access
    EmbeddedReportsUpdateTenantDataOnSigmaResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          $ref: '#/components/schemas/modelUpdateTenantDataOnSigmaResponseData'
    modelCopyWorkbookRequestData:
      type: object
      properties:
        workbookId:
          type: string
          title: The ID of workbook being copied
        name:
          type: string
          title: Name for the copied workbook
    modelCreateWorkbookResponseData:
      type: object
      properties:
        workbookId:
          type: string
          title: The workbook ID
        name:
          type: string
          title: The workbook name
        workbookUrlId:
          type: string
          title: The workbook's URL ID
    EmbeddedReportsRemoveSharedWorkbookAccessRequest:
      type: object
      properties:
        id:
          type: string
          title: Workbook ID
        data:
          $ref: '#/components/schemas/modelRemoveSharedWorkbookAccessRequestData'
    modelUpdateTenantDataOnSigmaRequestData:
      type: object
      properties:
        oldName:
          type: string
          title: Old name before update, which is used for workspace name
        newName:
          type: string
          title: New name to be updated, this will be the new workspace name
        description:
          type: string
          title: Description for the Sigma team
    EmbeddedReportsDeleteWorkbookResponse:
      type: object
      properties:
        success:
          type: boolean
    EmbeddedReportsGetUsersByPermissionResponse:
      type: object
      properties:
        success:
          type: boolean
        users:
          type: array
          items:
            $ref: '#/components/schemas/modelGetUsersByPermissionResponseData'
    modelRenameHomeFolderWorkbookRequestData:
      type: object
      properties:
        workbookId:
          type: string
          title: The workbook ID
        name:
          type: string
          title: Workbook name to be assigned
    EmbeddedReportsListHomeFolderWorkbooksResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          $ref: '#/components/schemas/modelHomeFolderData'
          title: Workbooks from the home folder
    EmbeddedReportsCreateWorkbookRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/modelCreateWorkbookRequestData'
    modelListSharedWithStatusResponseData:
      type: object
      properties:
        workbookOwner:
          $ref: '#/components/schemas/modelWorkbookOwner'
          title: Workbook owner's detail
        teamWorkbookPermission:
          type: string
          title: Workbook permission that is assigned to the team
        users:
          type: array
          items:
            $ref: '#/components/schemas/modelSharedUsers'
          title: List of users who have access to this workbook
    modelWorkspaces:
      type: object
      properties:
        name:
          type: string
          title: Workspace names
        workspaceId:
          type: string
          title: Workspace IDs
        workbooks:
          type: array
          items:
            $ref: '#/components/schemas/modelWorkbooks'
          title: Workbooks
    EmbeddedReportsGenerateURLResponse:
      type: object
      properties:
        success:
          type: boolean
        embedUrl:
          type: string
        isUserMigrated:
          type: boolean
    EmbeddedReportsCreateWorkbookResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          $ref: '#/components/schemas/modelCreateWorkbookResponseData'
    EmbeddedReportsGetUsersByPermissionRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/modelGetUsersByPermissionRequestData'
    EmbeddedReportsProvisionTenantToSigmaResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          $ref: '#/components/schemas/modelProvisionTenantToSigmaResponseData'
    EmbeddedReportsRemoveSharedWorkbookAccessResponse:
      type: object
      properties:
        success:
          type: boolean
    EmbeddedReportsShareWorkbookRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/modelShareWorkbookRequestData'
    EmbeddedReportsListSharedWithMeWorkbooksResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          $ref: '#/components/schemas/modelSharedWithMeData'
          title: Workbooks that have been shared with me
    modelSharedWithMeData:
      type: object
      properties:
        workbooks:
          type: array
          items:
            $ref: '#/components/schemas/modelWorkbooks'
          title: Workbooks that have been shared with the user
    modelShareWorkbookRequestData:
      type: object
      properties:
        workbookId:
          type: string
          title: Workbook ID user wants to give grant
        userGrantRequestData:
          type: array
          items:
            $ref: '#/components/schemas/modelUserGrantRequestData'
          title: Data for user grant request
        teamWorkbookPermission:
          type: string
          title: Workbook permission that will be assigned to the team. If this is empty, team does not have any access to the workbook
        isCustomWorkbook:
          type: boolean
          title: Identifies if the workbook is custom workbook
    modelClassicReportsData:
      type: object
      properties:
        category:
          type: string
          title: Report category for side nav
        reports:
          type: array
          items:
            $ref: '#/components/schemas/modelClassicReports'
          title: List of all available classic reports
    EmbeddedReportsListClassicReportsResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          $ref: '#/components/schemas/modelClassicReportsData'
    modelGetUsersByPermissionRequestData:
      type: object
      properties:
        permission:
          type: string
          title: Deputy permission
    modelHomeFolderData:
      type: object
      properties:
        workbooks:
          type: array
          items:
            $ref: '#/components/schemas/modelWorkbooks'
          title: Workspaces
    EmbeddedReportsRenameHomeFolderWorkbookRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/modelRenameHomeFolderWorkbookRequestData'
    EmbeddedReportsUpdateTenantDataOnSigmaRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/modelUpdateTenantDataOnSigmaRequestData'
    modelWorkbookOwner:
      type: object
      properties:
        userUuid:
          type: string
          title: Deputy user UUID
        displayName:
          type: string
          title: Deputy users' display name
    modelProvisionTenantToSigmaResponseData:
      type: object
      properties:
        teamId:
          type: string
          title: The team’s unique identifier
        createdBy:
          type: string
          title: The unique identifier, memberId, of the organization member who created the team
        updatedBy:
          type: string
          title: The unique identifier, memberId, of the organization member who last made changes to the team
        createdAt:
          type: string
          format: date-time
          title: The timestamp at which the team was created
        updatedAt:
          type: string
          format: date-time
          title: The timestamp at which the team was last updated
        name:
          type: string
          title: The team name
        description:
          type: string
          title: A description of the team
        visibility:
          type: string
          title: The team’s visibility setting
        isArchived:
          type: boolean
          title: True if the team is archived
        members:
          type: array
          items:
            type: string
          title: A list of unique identifiers (memberId) for all organization members assigned to the team
    EmbeddedReportsGenerateURLRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/modelEmbedPayload'
    modelUserGrantRequestData:
      type: object
      properties:
        userUuid:
          type: string
          title: Deputy User UUID to map Sigma member ID
        workbookPermission:
          type: string
          title: Workbook permission that will be assigned to this user
    v2modelData:
      type: object
      properties:
        category:
          type: string
          title: Report categories
        workspaces:
          type: array
          items:
            $ref: '#/components/schemas/modelWorkspaces'
          title: Workspaces
    modelSharedUsers:
      type: object
      properties:
        userUuid:
          type: string
          title: Deputy user UUID
        displayName:
          type: string
          title: Deputy users' display name
        workbookPermission:
          type: string
          title: Workbook permission that is assigned to this user
    modelCreateWorkbookRequestData:
      type: object
      properties:
        name:
          type: string
          title: name for the workbook
        description:
          type: string
          title: description for the workbook
    modelSigmaTenantData:
      type: object
      properties:
        hostname:
          type: string
          title: Hostname of the tenant, which will be used to name the Sigma team add workspace
        description:
          type: string
          title: Description for the Sigma team
    modelWorkbooks:
      type: object
      properties:
        workbookId:
          type: string
          title: Workbook IDs
        name:
          type: string
          title: Workbook names
        workbookUrlId:
          type: string
          title: Workbook URL IDs
        path:
          type: string
          title: Workbook paths
        ownerId:
          type: string
          title: Workbook ownerId
        isArchived:
          type: boolean
          title: Workbook isArchived
        permission:
          type: string
          title: Workbook permission, this is usually edit or view
    modelUpdateTenantDataOnSigmaResponseData:
      type: object
      properties:
        teamId:
          type: string
          title: The Sigma team ID
        name:
          type: string
          title: The Sigma team name
        createdBy:
          type: string
          title: The unique identifier, memberId, of the organization member who created the Sigma team
        updatedBy:
          type: string
          title: The unique identifier, memberId, of the organization member who last made changes to the Sigma team
        createdAt:
          type: string
          format: date-time
          title: The timestamp at which the Sigma team was created
        updatedAt:
          type: string
          format: date-time
          title: The timestamp at which the Sigma team was last updated
    EmbeddedReportsListSharedWithStatusResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          $ref: '#/components/schemas/modelListSharedWithStatusResponseData'
    modelGetUsersByPermissionResponseData:
      type: object
      properties:
        userUuid:
          type: string
          title: Deputy user UUID
        displayName:
          type: string
          title: Deputy user's display name
        canManage:
          type: boolean
          title: has user manage permission
    EmbeddedReportsCopyWorkbookResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          $ref: '#/components/schemas/modelCopyWorkbookResponseData'
  securitySchemes:
    ApiToken:
      type: apiKey
      in: header
      name: OAuth
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/accessmanagementv2controller_createrole.md
  - https://developer.deputy.com/reference/accessmanagementv2controller_deleterole.md
  - https://developer.deputy.com/reference/accessmanagementv2controller_getemployeerole.md
  - https://developer.deputy.com/reference/accessmanagementv2controller_getprivilegehierarchy.md
  - https://developer.deputy.com/reference/accessmanagementv2controller_listemployeebyrole.md
  - https://developer.deputy.com/reference/accessmanagementv2controller_listemployeerolehistory.md
  - https://developer.deputy.com/reference/accessmanagementv2controller_listrole.md
  - https://developer.deputy.com/reference/accessmanagementv2controller_updaterole.md
  - https://developer.deputy.com/reference/accountstatsv2controller_getpaycalendarcoverage.md
  - https://developer.deputy.com/reference/accountstatsv2controller_getpayratecoverage.md
  - https://developer.deputy.com/reference/agreedhourservicev2controller_archiveagreedhourversionwithreason.md
  - https://developer.deputy.com/reference/agreedhourservicev2controller_auditagreedhours.md
  - https://developer.deputy.com/reference/agreedhourservicev2controller_batchupdateagreedhour.md
  - https://developer.deputy.com/reference/agreedhourservicev2controller_consentemployeeagreedhours.md
  - https://developer.deputy.com/reference/agreedhourservicev2controller_createagreedhour.md
  - https://developer.deputy.com/reference/agreedhourservicev2controller_deleteemployeeagreedhours.md
  - https://developer.deputy.com/reference/agreedhourservicev2controller_diffemployeeagreedhours.md
  - https://developer.deputy.com/reference/agreedhourservicev2controller_getagreedhour.md
  - https://developer.deputy.com/reference/agreedhourservicev2controller_getagreedhoursbystatus.md
  - https://developer.deputy.com/reference/agreedhourservicev2controller_getagreedhoursemployeeapprovalconfiguration.md
  - https://developer.deputy.com/reference/agreedhourservicev2controller_getagreedhoursgeneralconfiguration.md
  - https://developer.deputy.com/reference/agreedhourservicev2controller_getagreedhourversion.md
  - https://developer.deputy.com/reference/agreedhourservicev2controller_getareasbyemployees.md
  - https://developer.deputy.com/reference/agreedhourservicev2controller_getconsentrecords.md
  - https://developer.deputy.com/reference/agreedhourservicev2controller_getcurrentagreedhour.md
  - https://developer.deputy.com/reference/agreedhourservicev2controller_migrateagreedhourssteptwo.md
  - https://developer.deputy.com/reference/agreedhourservicev2controller_notifyemployeeagreedhours.md
  - https://developer.deputy.com/reference/agreedhourservicev2controller_searchagreedhours.md
  - https://developer.deputy.com/reference/aiassistantv2controller_getsettings.md
  - https://developer.deputy.com/reference/areamanagementv2controller_listbyemployeeid.md
  - https://developer.deputy.com/reference/areaprofilev2controller_create.md
  - https://developer.deputy.com/reference/areaprofilev2controller_delete.md
  - https://developer.deputy.com/reference/areaprofilev2controller_get.md
  - https://developer.deputy.com/reference/areaprofilev2controller_list.md
  - https://developer.deputy.com/reference/areaprofilev2controller_listareainuse.md
  - https://developer.deputy.com/reference/areaprofilev2controller_listemployeetrained.md
  - https://developer.deputy.com/reference/areaprofilev2controller_update.md
  - https://developer.deputy.com/reference/arearatev2controller_batchsave.md
  - https://developer.deputy.com/reference/arearatev2controller_get.md
  - https://developer.deputy.com/reference/auditpayrecalculationv2controller_create.md
  - https://developer.deputy.com/reference/autobuildv2controller_autobuild.md
  - https://developer.deputy.com/reference/availabilityv2controller_delete.md
  - https://developer.deputy.com/reference/availabilityv2controller_get.md
  - https://developer.deputy.com/reference/availabilityv2controller_list.md
  - https://developer.deputy.com/reference/businesssettingv2controller_getallvisibleemployeeroles.md
  - https://developer.deputy.com/reference/businesssettingv2controller_getallvisibleemployeerolesincludeadvisor.md
  - https://developer.deputy.com/reference/businesssettingv2controller_getemployeeroleidsforprivilegenames.md
  - https://developer.deputy.com/reference/businesssettingv2controller_getemployeeroleidswithtwofaenforced.md
  - https://developer.deputy.com/reference/businesssettingv2controller_getsetting.md
  - https://developer.deputy.com/reference/businesssettingv2controller_gettemplate.md
  - https://developer.deputy.com/reference/businesssettingv2controller_saveconfig.md
  - https://developer.deputy.com/reference/businessv2controller_getdetails.md
  - https://developer.deputy.com/reference/businessv2controller_updatedetails.md
  - https://developer.deputy.com/reference/chatemployeeshiftstatusv2controller_getemployeesshiftstatus.md
  - https://developer.deputy.com/reference/compliancev2controller_associateleaverules.md
  - https://developer.deputy.com/reference/compliancev2controller_batchsavecontractconfigs.md


# --- truncated at 32 KB (60 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/openapi/deputy-embedded-reports-api-openapi.yml