# Deputy Embedded Reports API

**Canonical:** https://apis.io/apis/deputy/deputy-embedded-reports-api/  
**Provider:** Deputy — https://apis.io/providers/deputy/  
**Base URL:** https://{install}.{geo}.deputy.com/api/v1  
**Documentation:** https://developer.deputy.com/deputy-docs

Deputy Embedded Reports API is one of 217 APIs that [Deputy](https://apis.io/providers/deputy/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 28 JSON Schema definitions. Tagged areas include Embedded Reports. The published artifact set on APIs.io includes an OpenAPI specification and 28 JSON Schemas.

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

## Operations (16)

| Method | Path | Summary |
|---|---|---|
| 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 |

## Machine-readable artifacts (29)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/openapi/deputy-embedded-reports-api-openapi.yml
- **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

## Other Deputy APIs (12)

- [Deputy Public API](https://apis.io/apis/deputy/public-api/)
- [Deputy Access Management Employee API](https://apis.io/apis/deputy/deputy-access-management-employee-api/)
- [Deputy Access Management Employee Role API](https://apis.io/apis/deputy/deputy-access-management-employee-role-api/)
- [Deputy Access Management Employee Role History API](https://apis.io/apis/deputy/deputy-access-management-employee-role-history-api/)
- [Deputy Access Management Privilege Hierarchy API](https://apis.io/apis/deputy/deputy-access-management-privilege-hierarchy-api/)
- [Deputy Access Management Role API](https://apis.io/apis/deputy/deputy-access-management-role-api/)
- [Deputy Account Stats API](https://apis.io/apis/deputy/deputy-account-stats-api/)
- [Deputy Add Entitlement To Employees API](https://apis.io/apis/deputy/deputy-add-entitlement-to-employees-api/)
- [Deputy Address API](https://apis.io/apis/deputy/deputy-address-api/)
- [Deputy Agreed Hour API](https://apis.io/apis/deputy/deputy-agreed-hour-api/)
- [Deputy AI Assistant API](https://apis.io/apis/deputy/deputy-ai-assistant-api/)
- [Deputy Area Management API](https://apis.io/apis/deputy/deputy-area-management-api/)

## Tags

Embedded Reports

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/deputy/deputy-embedded-reports-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/deputy/.