Prisma

Prisma Workspaces API

Operations for managing Prisma Data Platform workspaces

GitHub OpenAPI

Operations 6

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /workspaces List all my workspaces · Prisma List all workspaces #
Ask an LLM
“Which workspaces do I have access to?”
“Can I see every workspace my account belongs to?”
Tell an agent
List my workspaces.
Show every workspace I can access.
GET /workspaces/{workspaceId} Get a workspace's billing and projects · Prisma Get a workspace #
Ask an LLM
“What is the billing status of my workspace?”
“Which projects are in a workspace along with its configuration?”
Tell an agent
Get workspace {workspaceId} with its projects.
Show the billing status and configuration of {workspaceId}.
PATCH /workspaces/{workspaceId} Rename a workspace · Prisma Update a workspace #
Ask an LLM
“How do I rename a workspace?”
“Can I change a workspace's settings after creating it?”
Tell an agent
Rename workspace {workspaceId} to {name}.
Change the name of {workspaceId} to {name}.
GET /v1/workspaces List workspaces my token can access (v1) · Get list of workspaces #
Ask an LLM
“Which workspaces can my current token reach via the v1 API?”
“Can I paginate the v1 workspace list?”
Tell an agent
List the workspaces this token can access.
Show {limit} workspaces from the v1 API.
GET /v1/workspaces/{id} Get a workspace by ID (v1) · Get workspace #
Ask an LLM
“What does the v1 API return for one workspace?”
“Can I fetch a single workspace by ID with the v1 endpoint?”
Tell an agent
Get workspace {id}.
Fetch workspace {id} from the v1 API.
GET /v1/workspaces/{id}/subscription Get a workspace's subscription · Get workspace subscription #
Ask an LLM
“Which plan is my workspace subscribed to?”
“Where can I check a workspace's subscription details?”
Tell an agent
Get the subscription for workspace {id}.
Show what plan {id} is on.

Documentation

📖
Authentication
https://www.prisma.io/docs/rest-api/authentication
📖
GettingStarted
https://www.prisma.io/docs/console/getting-started
📖
Documentation
https://www.prisma.io/docs/accelerate
📖
GettingStarted
https://www.prisma.io/docs/accelerate/getting-started
📖
Documentation
https://www.prisma.io/docs/orm
📖
GettingStarted
https://www.prisma.io/docs/prisma-orm/quickstart/prisma-postgres
📖
GettingStarted
https://www.prisma.io/docs/query-insights

Specifications

⚙
OpenAPI
https://artifacts.apis.io/prisma/openapi/prisma-workspaces-api-openapi.yml

Other Resources

🔗
Reference
https://www.prisma.io/docs/accelerate/reference/api-reference
🔗
FAQ
https://www.prisma.io/docs/accelerate/more/faq
🔗
SDKs
https://www.prisma.io/docs/rest-api/sdk
🔗
Reference
https://www.prisma.io/docs/orm/reference/prisma-client-reference
🔗
SDKs
https://www.npmjs.com/package/@prisma/client
🔗
SDKs
https://www.npmjs.com/package/@prisma/extension-optimize

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/prisma:prisma-workspaces-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.

GitHub Google LinkedIn

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

OpenAPI Specification

prisma-workspaces-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Prisma Workspaces API
  version: '1.0'
  description: 'Operations tagged Workspaces across 3 of this provider''s published API definitions: prisma-data-platform-openapi.yml, prisma-postgres-management-api-openapi.json, prisma-postgres-management-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.cloud.prisma.io
  description: Prisma Data Platform production server
- url: https://api.prisma.io
- url: https://api.prisma.io/v1
  description: Prisma Management API production server
tags:
- name: Workspaces
  description: Operations for managing Prisma Data Platform workspaces
paths:
  /workspaces:
    get:
      operationId: listWorkspaces
      summary: Prisma List all workspaces
      description: Retrieves a list of all workspaces accessible to the authenticated user. Each workspace contains projects, environments, and associated resources.
      tags:
      - Workspaces
      responses:
        '200':
          description: Successfully retrieved list of workspaces
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Workspace'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
      - bearerAuth: []
    servers:
    - url: https://api.cloud.prisma.io
      description: Prisma Data Platform production server
  /workspaces/{workspaceId}:
    get:
      operationId: getWorkspace
      summary: Prisma Get a workspace
      description: Retrieves detailed information about a specific workspace including its configuration, billing status, and associated projects.
      tags:
      - Workspaces
      parameters:
      - $ref: '#/components/parameters/WorkspaceId'
      responses:
        '200':
          description: Successfully retrieved workspace details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workspace'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
      - bearerAuth: []
    patch:
      operationId: updateWorkspace
      summary: Prisma Update a workspace
      description: Updates the configuration of a specific workspace, such as its name or settings.
      tags:
      - Workspaces
      parameters:
      - $ref: '#/components/parameters/WorkspaceId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkspaceUpdate'
      responses:
        '200':
          description: Successfully updated workspace
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workspace'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
      - bearerAuth: []
    servers:
    - url: https://api.cloud.prisma.io
      description: Prisma Data Platform production server
  /v1/workspaces:
    get:
      responses:
        '200':
          description: Returns the list of workspaces the current token can access.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          pattern: ^(wksp_)([cC][^\s-]{8,}|[a-z0-9]+)$
                        type:
                          type: string
                          const: workspace
                        url:
                          type: string
                          format: uri
                        name:
                          type: string
                        createdAt:
                          type: string
                          format: date-time
                      required:
                      - id
                      - type
                      - url
                      - name
                      - createdAt
                  pagination:
                    type: object
                    properties:
                      nextCursor:
                        type:
                        - string
                        - 'null'
                        description: Next cursor to continue pagination
                      hasMore:
                        type: boolean
                        description: Whether there are more items to paginate
                    required:
                    - nextCursor
                    - hasMore
                required:
                - data
                - pagination
        '401':
          description: Missing or invalid authorization token.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      hint:
                        type: string
                    required:
                    - code
                    - message
                required:
                - error
      operationId: getV1Workspaces
      tags:
      - Workspaces
      parameters:
      - in: query
        name: cursor
        schema:
          type:
          - string
          - 'null'
          description: Cursor for pagination
      - in: query
        name: limit
        schema:
          type: number
          default: 100
          description: Limit for pagination
      summary: Get list of workspaces
      description: Returns the list of workspaces the current token can access.
      security:
      - OAuth2:
        - workspace:admin
        - offline_access
      - Bearer: []
    servers:
    - url: https://api.prisma.io
  /v1/workspaces/{id}:
    get:
      responses:
        '200':
          description: Workspace retrieved.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        pattern: ^(wksp_)([cC][^\s-]{8,}|[a-z0-9]+)$
                      type:
                        type: string
                        const: workspace
                      url:
                        type: string
                        format: uri
                      name:
                        type: string
                      createdAt:
                        type: string
                        format: date-time
                    required:
                    - id
                    - type
                    - url
                    - name
                    - createdAt
                required:
                - data
        '401':
          description: Missing or invalid authorization token.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      hint:
                        type: string
                    required:
                    - code
                    - message
                required:
                - error
        '404':
          description: Workspace with the specified ID was not found.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      hint:
                        type: string
                    required:
                    - code
                    - message
                required:
                - error
      operationId: getV1WorkspacesById
      tags:
      - Workspaces
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^(wksp_)?([cC][^\s-]{8,}|[a-z0-9]+)$
        required: true
      summary: Get workspace
      description: Returns the workspace with the given ID.
      security:
      - OAuth2:
        - workspace:admin
        - offline_access
      - Bearer: []
    servers:
    - url: https://api.prisma.io
  /v1/workspaces/{id}/subscription:
    get:
      responses:
        '200':
          description: Workspace subscription retrieved.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      planName:
                        type: string
                      usageBlocked:
                        type: boolean
                      upgradeUrl:
                        type: string
                        format: uri
                    required:
                    - planName
                    - usageBlocked
                    - upgradeUrl
                required:
                - data
        '401':
          description: Missing or invalid authorization token.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      hint:
                        type: string
                    required:
                    - code
                    - message
                required:
                - error
        '404':
          description: Workspace with the specified ID was not found.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      hint:
                        type: string
                    required:
                    - code
                    - message
                required:
                - error
      operationId: getV1WorkspacesByIdSubscription
      tags:
      - Workspaces
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^(wksp_)?([cC][^\s-]{8,}|[a-z0-9]+)$
        required: true
      summary: Get workspace subscription
      description: Returns subscription information for the workspace with the given ID.
      security:
      - OAuth2:
        - workspace:admin
        - offline_access
      - Bearer: []
    servers:
    - url: https://api.prisma.io
components:
  parameters:
    WorkspaceId:
      name: workspaceId
      in: path
      required: true
      description: Unique identifier of the workspace
      schema:
        type: string
  responses:
    RateLimited:
      description: Too many requests - rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: The request was invalid or malformed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: The requested resource was not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Authentication is required or the provided credentials are invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InternalServerError:
      description: An unexpected error occurred on the server
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Workspace:
      type: object
      description: A workspace is the top-level organizational unit in the Prisma Data Platform that contains projects, members, and billing configuration.
      properties:
        id:
          type: string
          description: Unique identifier for the workspace
          examples:
          - ws_abc123def456
        name:
          type: string
          description: Display name of the workspace
          examples:
          - My Workspace
        slug:
          type: string
          description: URL-friendly identifier for the workspace
          examples:
          - my-workspace
        plan:
          type: string
          description: Current billing plan for the workspace
          enum:
          - free
          - pro
          - business
          - enterprise
        createdAt:
          type: string
          format: date-time
          description: Timestamp when the workspace was created
        updatedAt:
          type: string
          format: date-time
          description: Timestamp when the workspace was last updated
      required:
      - id
      - name
      - slug
      - plan
      - createdAt
      - updatedAt
    WorkspaceUpdate:
      type: object
      description: Fields that can be updated on a workspace
      properties:
        name:
          type: string
          description: New display name for the workspace
    Error:
      type: object
      description: Standard error response from the API
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Machine-readable error code
            message:
              type: string
              description: Human-readable error message
            details:
              type: object
              description: Additional error context
              additionalProperties: true
          required:
          - code
          - message
    Workspace_2:
      type: object
      description: A workspace is the top-level organizational unit containing projects, databases, and team members with shared billing.
      properties:
        id:
          type: string
          description: Unique identifier for the workspace
        name:
          type: string
          description: Display name of the workspace
        slug:
          type: string
          description: URL-friendly identifier for the workspace
        plan:
          type: string
          description: Current billing plan
          enum:
          - free
          - pro
          - business
          - enterprise
        createdAt:
          type: string
          format: date-time
          description: Timestamp when the workspace was created
        updatedAt:
          type: string
          format: date-time
          description: Timestamp when the workspace was last updated
      required:
      - id
      - name
      - slug
      - plan
      - createdAt
      - updatedAt
    Error_2:
      type: object
      description: Standard error response
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Machine-readable error code
            message:
              type: string
              description: Human-readable error message
            details:
              type: object
              description: Additional error context
              additionalProperties: true
          required:
          - code
          - message
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Authentication via service token or OAuth 2.0 access token. Service tokens are created in the Prisma Console under workspace settings.
    OAuth2:
      type: oauth2
      description: OAuth2 authentication
      flows:
        authorizationCode:
          authorizationUrl: https://auth.prisma.io/authorize
          tokenUrl: https://auth.prisma.io/token
          refreshUrl: https://auth.prisma.io/token
          scopes:
            workspace:admin: Full access to workspace resources
            offline_access: Offline access
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth2 token for API authentication
x-refined-from:
- prisma-data-platform-openapi.yml
- prisma-postgres-management-api-openapi.json
- prisma-postgres-management-openapi.yml