> ## Documentation Index
> Fetch the complete documentation index at: https://enterprise-docs.dify.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Admin APIs

> Requires Dify Enterprise version ≥ v2.2.0

Admin APIs adhere to REST API standards, enabling efficient automation and management within the Dify Enterprise platform. These APIs support querying and modifying information for the following resources:

* **Workspaces**: Global workspace management, including querying workspace information and performing management operations.
* **Members**: Global team member management, including querying team member details and managing accounts.
* **Workspace Member**: Management of members within a specific workspace, including querying member information and managing members.

> More features will be supported with future version updates, including enhanced operations and resource management.

***

## API Types

To avoid confusion, Dify distinguishes between different levels of API services:

* APIs provided by applications are referred to as **Workspace APIs**.
* APIs for managing platform-level operations are collectively called **Admin APIs**.

***

## Endpoint URL

Admin APIs use the following endpoint address. When making API calls, replace `your-domain` with your Dify Enterprise platform domain name and append the specific request path to form the complete API endpoint.

```bash theme={null}
https://your-domain/admin-api/v1
```

***

## Authentication

API requests require a Secret Key for authentication. To obtain one, navigate to the **Admin APIs** page in the Dify Enterprise admin dashboard to generate and configure the Key.

<Warning>
  Modifying data via Admin APIs may impact production data within your organization. Please proceed with caution.
</Warning>

***

![API Documentation](https://assets-docs.dify.ai/2025/02/0431242649acccbcbcf23fa8e4268ce8.png)

***

## Usage Example

To facilitate understanding of the Admin APIs, here is an example of how to retrieve the list of workspaces.

### 1. Create an API Key

* Log in to the Dify Enterprise admin dashboard.
* Navigate to the **Admin APIs**.
* Click the **Add** button in the top-right corner and follow the prompts to create a key by entering a name.

***

### 2. Import the API Collection and Configure Variables

Click the **Postman Collection** link on the page to download the configuration file.

![Postman Collection Download](https://assets-docs.dify.ai/2025/02/5aa925f58ec5bb12a2838704f1444525.png)

Import the configuration file into Postman. Replace the `base_url` and `secret_key` variables in the **Variables**.

![Postman Variables Configuration](https://assets-docs.dify.ai/2025/02/786336845c4d67117fdede872eb7883b.png)

***

### 3. Send the Request

Send the request and receive the response. You can view the complete list of workspaces and their corresponding information within the current enterprise version in the response.

```json theme={null}
{
    "data": [
        {
            "id": "a7145b74-****--****---****",     # Workspace ID
            "name": "Workspace A Name",             # Workspace Name
            "status": "normal",                     # Workspace Status
            "created_at": "2025-02-08T02:45:33Z",   # The Create Time of Workspace
            "updated_at": "2025-02-08T02:45:33Z"    # The Update Time of Workspace
        },
        {
            "id": "bbffbfdf-****--****---****",
            "name": "Dify's Workspace",
            "status": "normal",
            "created_at": "2025-02-07T16:55:59Z",
            "updated_at": "2025-02-07T16:55:59Z"
        },
    ],
    "has_more": true,
    "limit": 10,
    "page": 1,
    "total": 491
}
```

![API Request and Response](https://assets-docs.dify.ai/2025/02/bd4d300b08ceed74c17c3b428329fa19.png)