APIs.io Engineering Platform Workspaces API

openapi: 3.2.0
info:
  title: APIs.io Engineering Platform Postman Workspaces API
  description: "The Postman API enables you to programmatically access data stored in your Postman account.\n\n> Certain endpoints may be unavailable depending on your region and/or Postman plan.\n\nFor a comprehensive set of examples of requests and responses, see the [**Postman API** collection](https://www.postman.com/postman/workspace/postman-public-workspace/documentation/12959542-c8142d51-e97c-46b6-bd77-52bb66712c9a).\n\n## Getting started\n\nYou can get started with the Postman API by creating a copy of this definition in your workspace.\n\n### EU users\n\nFor users in the EU with [**Enterprise** plans](https://www.postman.com/pricing/), the Postman API uses the `http://api.eu.postman.com` subdomain. This is available in the definition's list of servers. You can change this by selecting the `http://api.eu.postman.com` subdomain in the **Server** dropdown list below.\n\n## About the Postman API\n\n- You must use a valid API Key to send requests to the API endpoints.\n- The API has [rate and usage limits](https://learning.postman.com/docs/developer/postman-api/postman-api-rate-limits/).\n- The API only responds to HTTPS-secured communications. Any requests sent via HTTP return an HTTP `301` redirect to the corresponding HTTPS resources.\n- The API returns requests responses in JSON format. When an API request returns an error, it is sent in the JSON response as an error key.\n- The request method (verb) determines the nature of action you intend to perform. A request made using the `GET` method implies that you want to fetch something from Postman. The `POST` method implies you want to save something new to Postman.\n- For all requests, API calls respond with their corresponding [HTTP status codes](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes). In the Postman client, the status code also provides help text that details the possible meaning of the response code.\n- When calling the API Builder endpoints, you must send an `Accept` header with the `application/vnd.api.v10+json` value.\n\n### IDs and UIDs\n\nAll items in Postman, such as collections, workspaces, and APIs, have IDs and UIDs:\n\n- An ID is the unique ID assigned to a Postman item. For example, `ec29121c-5203-409f-9e84-e83ffc10f226`.\n- The UID is the **full** ID of a Postman item. This value is the item's unique ID concatenated with the user ID. For example, in the `12345678-ec29121c-5203-409f-9e84-e83ffc10f226` UID:\n    - `12345678` is the user's ID.\n    - `ec29121c-5203-409f-9e84-e83ffc10f226` is the item's ID.\n\n### Enum values\n\nAny documented enum values should be considered partial lists and may change over time.\n\n### 403 response for unavailable features\n\nDepending on your region and/or Postman [plan](https://www.postman.com/pricing/), some endpoints will return an HTTP `403 Forbidden` response with the \"This feature isn't available in your region.\" detail.\n\n### 503 response\n\nAn HTTP `503 Service Unavailable` response from our servers indicates there is an unexpected spike in API access traffic. The server is usually operational within the next five minutes.\n\nIf the outage persists or you receive any other form of an HTTP `5XX` error, [contact support](https://support.postman.com/hc/en-us/requests/new/).\n\n## Authentication\n\nPostman uses API keys for authentication. The API key tells the API server that the request came from you. Everything that you have access to in Postman is accessible with your API key. You can [generate](https://learning.postman.com/docs/developer/postman-api/authentication/#generate-a-postman-api-key) a Postman API key in the [**API keys**](https://postman.postman.co/settings/me/api-keys) section of your Postman account settings.\n\nYou must include an API key in each request to the Postman API with the `X-API-Key` request header. In Postman, you can store your API key as a [vault secret](https://learning.postman.com/docs/sending-requests/postman-vault/postman-vault-secrets/) or an [environment variable](https://www.getpostman.com/docs/environments). The Postman API [collection](https://www.getpostman.com/docs/collections) will use it to make API calls.\n\n### SCIM authentication\n\nWhile all other endpoints in this collection require a Postman API key, the SCIM endpoints require a [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key).\n\n### Authentication error response\n\nIf an API key is missing, malformed, or invalid, you will receive an HTTP `401 Unauthorized` response code.\n\n## Rate and usage limits\n\nAPI access [rate limits](https://learning.postman.com/docs/developer/postman-api/postman-api-rate-limits/) apply at a per-user basis in unit time. The limit is **300 requests per minute**. Postman Monitors, the GET `/collections`, and the GET `/workspaces` endpoint have a rate limit of **10 calls in 10 seconds**. Depending on your [plan](https://www.postman.com/pricing/), you may also have [usage limits](https://learning.postman.com/docs/billing/resource-usage/).\n\nWhen you reach your rate or usage limits, the API returns the following HTTP `429 Too Many Requests` status code with one of the following error responses:\n\n- `rateLimited` — Rate limits reached. The response returns the time after which you can resume calls to the Postman API.\n- `serviceLimitExhausted` — Postman API service limits reached. You will need to contact your Postman Team Admin for assistance.\n\n## Support\n\nFor help regarding accessing the Postman API, you can:\n\n- Visit [Postman Support](https://support.postman.com/hc/en-us) or our [Community and Support](https://www.postman.com/community/) sites.\n- Reach out to the [Postman community](https://community.postman.com/).\n- Submit a help request to [Postman support](https://support.postman.com/hc/en-us/requests/new/).\n\n## Policies\n\n- [Postman Terms of Service](http://www.postman.com/legal/terms/)\n- [Postman Privacy Policy](https://www.postman.com/legal/privacy-policy/)\n"
  version: '1.0'
  termsOfService: https://www.postman.com/legal/terms/
  contact:
    name: Postman Support
    email: help@postman.com
    url: https://www.postman.com/community/
servers:
- url: https://api.getpostman.com
- url: https://api.eu.postman.com
security:
- PostmanApiKey: []
- scimApiKey: []
tags:
- name: Workspaces
  description: The **Workspaces** endpoints enable you to manage your [workspaces](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/creating-workspaces/). The Workspaces endpoints let you manage your workspaces. Workspaces enable you to organize your Postman work and collaborate with teammates.
paths:
  /workspaces:
    get:
      summary: APIs.io Engineering Platform Get all workspaces
      description: 'Gets all [workspaces](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/creating-workspaces/). The response includes your workspaces and any workspaces that you have access to.


        **Note:**


        This endpoint''s response contains the visibility field. Visibility determines who can access the workspace:

        - `personal` — Only you can access the workspace.

        - `team` — All team members can access the workspace.

        - `private` — Only invited team members can access the workspace ([**Professional** and **Enterprise** plans only](https://www.postman.com/pricing)).

        - `public` — Everyone can access the workspace.

        - `partner` — Only invited team members and [partners](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/) can access the workspace ([**Professional** and **Enterprise** plans only](https://www.postman.com/pricing)).

        '
      operationId: getWorkspaces
      tags:
      - Workspaces
      responses:
        '200':
          $ref: '#/components/responses/getWorkspaces'
        '401':
          $ref: '#/components/responses/common401Error'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
      parameters:
      - $ref: '#/components/parameters/workspaceTypeQuery'
      - $ref: '#/components/parameters/workspaceCreatedBy'
      - $ref: '#/components/parameters/workspaceIncludeQuery'
    post:
      summary: APIs.io Engineering Platform Create a workspace
      description: 'Creates a new [workspace](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/creating-workspaces/).


        **Note:**


        This endpoint returns a 403 `Forbidden` response if the user does not have permission to create workspaces. [Admins and Super Admins](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles) can configure workspace permissions to restrict users and/or user groups from creating workspaces or require approvals for the creation of team workspaces.


        ### Important


        We deprecated linking collections or environments between workspaces. We do not recommend that you do this.


        If you have a linked collection or environment, note the following:

        - The endpoint does not create a clone of a collection or environment.

        - Any changes you make to a linked collection or environment changes them in all workspaces.

        - If you delete a collection or environment linked between workspaces, the system deletes it in all the workspaces.

        '
      operationId: createWorkspace
      tags:
      - Workspaces
      requestBody:
        $ref: '#/components/requestBodies/createWorkspace'
      responses:
        '200':
          $ref: '#/components/responses/createWorkspace'
        '400':
          $ref: '#/components/responses/workspace400ErrorMalformedRequest'
        '401':
          $ref: '#/components/responses/common401Error'
        '403':
          $ref: '#/components/responses/workspace403ErrorUnauthorized'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
  /workspaces-roles:
    get:
      summary: APIs.io Engineering Platform Get all roles
      description: 'Gets information about all roles in a workspace, based on the team''s [plan](https://www.postman.com/pricing/).

        '
      operationId: getAllWorkspaceRoles
      tags:
      - Workspaces
      responses:
        '200':
          $ref: '#/components/responses/getAllWorkspaceRoles'
        '401':
          $ref: '#/components/responses/api401ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/common403ErrorPermissions'
        '500':
          $ref: '#/components/responses/common500ErrorInternalServer'
  /workspaces/{workspaceId}:
    parameters:
    - $ref: '#/components/parameters/workspaceId'
    get:
      summary: APIs.io Engineering Platform Get a workspace
      description: 'Gets information about a workspace.


        **Note:**


        This endpoint''s response contains the `visibility` field. [Visibility](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/#changing-workspace-visibility) determines who can access the workspace:

        - `personal` — Only you can access the workspace.

        - `team` — All team members can access the workspace.

        - `private` — Only invited team members can access the workspace ([**Professional** and **Enterprise** plans only](https://www.postman.com/pricing)).

        - `public` — Everyone can access the workspace.

        - `partner` — Only invited team members and [partners](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/) can access the workspace ([**Professional** and **Enterprise** plans only](https://www.postman.com/pricing)).


        ### Important


        We have deprecated the `name` and `uid` responses in the following array of objects:

        - `collections`

        - `environments`

        - `mocks`

        - `monitors`

        - `apis`

        '
      operationId: getWorkspace
      tags:
      - Workspaces
      responses:
        '200':
          $ref: '#/components/responses/getWorkspace'
        '401':
          $ref: '#/components/responses/common401Error'
        '404':
          $ref: '#/components/responses/workspace404ErrorNotFound'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
      parameters:
      - $ref: '#/components/parameters/workspaceIncludeQuery'
    put:
      summary: APIs.io Engineering Platform Update a workspace
      description: 'Updates a workspace.


        ### Important


        We deprecated linking collections or environments between workspaces. We do not recommend that you do this.


        If you have a linked collection or environment, note the following:

        - The endpoint does not create a clone of a collection or environment.

        - Any changes you make to a linked collection or environment changes them in all workspaces.

        - If you delete a collection or environment linked between workspaces, the system deletes it in all the workspaces.

        '
      operationId: updateWorkspace
      tags:
      - Workspaces
      requestBody:
        $ref: '#/components/requestBodies/updateWorkspace'
      responses:
        '200':
          $ref: '#/components/responses/updateWorkspace'
        '400':
          $ref: '#/components/responses/workspace400ErrorMalformedRequest'
        '403':
          $ref: '#/components/responses/workspace403Error'
        '404':
          $ref: '#/components/responses/instanceNotFoundWorkspace'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
    delete:
      summary: APIs.io Engineering Platform Delete a workspace
      description: 'Deletes an existing workspace.


        ### Important


        If you delete a workspace that has a linked collection or environment with another workspace, this will delete the collection and environment in all workspaces.

        '
      operationId: deleteWorkspace
      tags:
      - Workspaces
      responses:
        '200':
          $ref: '#/components/responses/deleteWorkspace'
        '400':
          $ref: '#/components/responses/workspace400Error'
        '401':
          $ref: '#/components/responses/common401Error'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
  /workspaces/{workspaceId}/global-variables:
    parameters:
    - $ref: '#/components/parameters/workspaceId'
    get:
      summary: APIs.io Engineering Platform Get global variables
      description: Gets a workspace's global [variables](https://learning.postman.com/docs/sending-requests/variables/#variable-scopes).
      operationId: getWorkspaceGlobalVariables
      tags:
      - Workspaces
      responses:
        '200':
          $ref: '#/components/responses/getWorkspaceGlobalVariables'
        '500':
          $ref: '#/components/responses/globalVariables500Error'
    put:
      summary: APIs.io Engineering Platform Update global variables
      description: Updates and replaces a workspace's global [variables](https://learning.postman.com/docs/sending-requests/variables/#variable-scopes). This endpoint replaces all existing global variables with the variables you pass in the request body.
      operationId: updateWorkspaceGlobalVariables
      tags:
      - Workspaces
      requestBody:
        $ref: '#/components/requestBodies/updateWorkspaceGlobalVariables'
      responses:
        '200':
          $ref: '#/components/responses/updateWorkspaceGlobalVariables'
        '500':
          $ref: '#/components/responses/globalVariables500Error'
  /workspaces/{workspaceId}/roles:
    parameters:
    - $ref: '#/components/parameters/workspaceId'
    patch:
      summary: APIs.io Engineering Platform Update user or user group roles
      description: 'Updates the roles of [users](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles) or [user groups](https://learning.postman.com/docs/collaborating-in-postman/user-groups/) in a workspace. To get a list of roles, use the `GET /workspace-roles` endpoint.


        **Note:**


        - To use SCIM IDs, include the `identifierType=scim` header when you call this endpoint. To get SCIM user IDs, include the `include=scim` query parameter when calling the GET `/workspaces/{workspaceId}` or GET `/workspaces` endpoints.

        - You cannot set roles for users in personal and partner workspaces.

        - This endpoint does not support the external [Partner or Guest roles](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles).

        - This endpoint is restricted to 50 operations per call.

        - The request body must contain one unique action per user or user group. For example, you cannot add and remove multiple roles for a user in the same request body.

        '
      operationId: updateWorkspaceRoles
      tags:
      - Workspaces
      requestBody:
        $ref: '#/components/requestBodies/updateWorkspaceRoles'
      responses:
        '200':
          $ref: '#/components/responses/updateWorkspaceRoles'
        '400':
          $ref: '#/components/responses/workspaceRoles400Error'
        '401':
          $ref: '#/components/responses/unauthorizedError'
        '403':
          $ref: '#/components/responses/common403ErrorPermissions'
        '404':
          $ref: '#/components/responses/resourceNotFound404Error'
        '422':
          $ref: '#/components/responses/workspaceRoles422UnsupportRoleError'
        '500':
          $ref: '#/components/responses/common500ErrorInternalServer'
      parameters:
      - $ref: '#/components/parameters/identifierType'
    get:
      summary: APIs.io Engineering Platform Get a workspace's roles
      description: 'Gets the roles of users and user groups in a workspace:

        - `Viewer` — Can view, fork, and export workspace resources.

        - `Editor` — Can create and edit workspace resources.

        - `Admin` — Can manage workspace details and members.

        '
      operationId: getWorkspaceRoles
      tags:
      - Workspaces
      responses:
        '200':
          $ref: '#/components/responses/getWorkspaceRoles'
        '401':
          $ref: '#/components/responses/unauthorizedError'
        '403':
          $ref: '#/components/responses/common403ErrorPermissions'
        '404':
          $ref: '#/components/responses/resourceNotFound404Error'
        '500':
          $ref: '#/components/responses/common500ErrorInternalServer'
      parameters:
      - $ref: '#/components/parameters/workspaceIncludeScimQuery'
components:
  parameters:
    workspaceTypeQuery:
      name: type
      in: query
      description: The type of workspace to filter the response by.
      schema:
        type: string
        example: team
        enum:
        - personal
        - team
        - private
        - public
        - partner
    workspaceCreatedBy:
      name: createdBy
      in: query
      description: Return only workspaces created by a specific user ID. For multiple users, pass this value as a comma-separated list of user IDs. The response only returns workspaces that you have access to.
      schema:
        type: integer
        example: 12345678
    workspaceIncludeQuery:
      name: include
      in: query
      description: 'Include the following information in the endpoint''s response:

        - `mocks:deactivated` — Include all deactivated mock servers in the response.

        - `scim` — Return the SCIM user IDs of the workspace creator and who last modified it.

        '
      schema:
        type: string
        example: mocks:deactivated
        enum:
        - mocks:deactivated
        - scim
    workspaceIncludeScimQuery:
      name: include
      in: query
      description: 'Include the following information in the endpoint''s response:

        - `scim` — Return IDs as SCIM user and group IDs.

        '
      schema:
        type: string
        example: scim
        enum:
        - scim
    workspaceId:
      name: workspaceId
      in: path
      required: true
      description: The workspace's ID.
      schema:
        $ref: '#/components/schemas/workspaceId'
    identifierType:
      name: identifierType
      in: header
      description: Use SCIM user IDs instead of Postman user IDs.
      schema:
        type: string
        example: scim
  responses:
    updateWorkspace:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              workspace:
                type: object
                description: Information about the updated workspace.
                properties:
                  id:
                    type: string
                    description: The workspace's ID.
                    example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9
                  name:
                    type: string
                    description: The workspace's name.
                    example: Test Workspace
          example:
            workspace:
              id: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9
              name: Test Workspace
    workspace404ErrorNotFound:
      description: Not Found
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  name:
                    type: string
                    description: The error name.
                    example: workspaceNotFoundError
                  message:
                    type: string
                    description: The error message.
                    example: Workspace not found
                  statusCode:
                    type: number
                    format: http-status-code
                    description: The error's HTTP status code.
                    example: 404
          example:
            error:
              name: workspaceNotFoundError
              message: Workspace not found
              statusCode: 404
    common401Error:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              type:
                type: string
                format: uri-reference
                description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem.
                example: https://api.postman.com/problems/unauthorized
              title:
                type: string
                description: A short summary of the problem.
                example: Unauthorized
              detail:
                type: string
                description: Information about the error.
                example: Unauthorized
              status:
                type: integer
                format: http-status-code
                description: The error's HTTP status code.
                example: 401
          example:
            type: https://api.postman.com/problems/unauthorized
            title: Unauthorized
            detail: Unauthorized
            status: 401
    getWorkspaces:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              workspaces:
                type: array
                items:
                  type: object
                  description: Information about the workspace.
                  properties:
                    id:
                      type: string
                      description: The workspace's ID.
                      example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9
                    name:
                      type: string
                      description: The workspace's name.
                      example: Team Workspace
                    type:
                      type: string
                      description: The type of workspace.
                      enum:
                      - personal
                      - team
                      - private
                      - public
                      - partner
                      example: team
                    visibility:
                      type: string
                      description: 'The workspace''s visibility. [Visibility](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/#changing-workspace-visibility) determines who can access the workspace:

                        - `personal` — Only you can access the workspace.

                        - `team` — All team members can access the workspace.

                        - `private` — Only invited team members can access the workspace ([**Professional** and **Enterprise** plans only](https://www.postman.com/pricing)).

                        - `public` — Everyone can access the workspace.

                        - `partner` — Only invited team members and [partners](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/) can access the workspace ([**Professional** and **Enterprise** plans only](https://www.postman.com/pricing)).

                        '
                      enum:
                      - personal
                      - team
                      - private
                      - public
                      - partner
                      example: team
                    createdBy:
                      type: integer
                      description: The user who created the workspace. The response only returns workspaces that you have access to.
                      example: 12345678
                    scim:
                      type: object
                      description: An object containing SCIM user IDs. This object only returns if you pass the `include=scim` query parameter.
                      properties:
                        createdBy:
                          type: string
                          description: The SCIM user ID of the user who created the workspace.
                          example: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99
          examples:
            Successful Response:
              value:
                workspaces:
                - id: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9
                  name: My Workspace
                  createdBy: 12345678
                  type: personal
                  visibility: personal
                - id: a0f46158-1529-11ee-be56-0242ac120002
                  name: Private Workspace
                  createdBy: 12345678
                  type: team
                  visibility: private
                - id: f8801e9e-03a4-4c7b-b31e-5db5cd771696
                  name: Team Workspace
                  createdBy: 12345678
                  type: team
                  visibility: team
                - id: 74dbfab8-1529-11ee-be56-0242ac120002
                  name: Public Workspace
                  createdBy: 12345678
                  type: team
                  visibility: public
                - id: 74dbfab8-1529-11ee-be56-0242ac120002
                  name: Partner Workspace
                  createdBy: 12345678
                  type: team
                  visibility: partner
            Include SCIM IDs:
              value:
                workspaces:
                - id: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9
                  name: My Workspace
                  type: personal
                  visibility: personal
                  createdBy: 12345678
                  scim:
                    createdBy: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99
    deleteWorkspace:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              workspace:
                type: object
                description: Information about the deleted workspace.
                properties:
                  id:
                    type: string
                    description: The workspace's ID.
                    example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9
          example:
            workspace:
              id: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9
    common500ErrorInternalServer:
      description: Internal Server Error
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              type:
                type: string
                format: uri-reference
                description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem.
                example: https://api.postman.com/problems/internal-server-error
              title:
                type: string
                description: A short summary of the problem.
                example: Internal Sever Error
              detail:
                type: string
                description: An explanation about the problem.
                example: Internal Sever Error
              status:
                type: integer
                format: http-status-code
                description: The HTTP status code generated by the origin server.
                example: 500
          example:
            type: https://api.postman.com/problems/internal-server-error
            title: Internal Server Error
            detail: Internal Server Error
            status: 500
    workspaceRoles400Error:
      description: Bad Request
      content:
        application/json:
          schema:
            type: object
            properties:
              type:
                type: string
                description: The error type.
                example: invalidParamError
              title:
                type: string
                description: A short summary of the problem.
                example: body.roles[0] should have required property 'op'
              detail:
                type: string
                description: Information about the error.
                example: ''
              status:
                type: number
                format: http-status-code
                description: The error's HTTP status code.
                example: 400
          example:
            type: invalidParamError
            title: body.roles[0] should have required property 'op'
            detail: ''
            status: 400
    common403ErrorPermissions:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              type:
                type: string
                format: uri-reference
                description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem.
                example: https://api.postman.com/problems/forbidden
              title:
                type: string
                description: A short summary of the problem.
                example: Resource cannot be accessed
              detail:
                type: string
                description: Information about the error.
                example: Inadequate permissions. Resource access forbidden.
              status:
                type: number
                format: http-status-code
                description: The error's HTTP status code.
                example: 403
          example:
            type: https://api.postman.com/problems/forbidden
            title: Resource cannot be accessed
            detail: Inadequate permissions. Resource access forbidden.
            status: 403
    workspace400Error:
      description: Not Found
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  name:
                    type: string
                    description: The error name.
                    example: instanceNotFoundError
                  message:
                    type: string
                    description: The error message.
                    example: The specified workspace does not exist.
          example:
            error:
              name: instanceNotFoundError
              message: The specified workspace does not exist.
    api401ErrorUnauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            typ

# --- truncated at 32 KB (72 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/engineering-platform/refs/heads/main/openapi/engineering-platform-workspaces-api-openapi.yml