APIs.io Engineering Platform Forks API

The **Forks** endpoints enable you to manage element [forks](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/forking-elements/). Forks are new instances of an element that you can change without making any changes to the parent element.

Operations 10

POST /collections/fork/{collectionId} APIs.io Engineering Platform Create a fork #
POST /collections/merge APIs.io Engineering Platform Merge a fork #
GET /collections/{collectionId}/collection-forks APIs.io Engineering Platform Get all forked collections #
GET /collections/{collectionId}/forks APIs.io Engineering Platform Get a collection's forks #
PUT /collections/{collectionId}/pulls APIs.io Engineering Platform Pull source changes #
GET /collections/{collectionId}/source-status APIs.io Engineering Platform Get source collection's status #
POST /environments/{environmentId}/forks APIs.io Engineering Platform Create a fork #
GET /environments/{environmentId}/forks APIs.io Engineering Platform Get an environment's forks #
POST /environments/{environmentId}/merges APIs.io Engineering Platform Merge a fork #
POST /environments/{environmentId}/pulls APIs.io Engineering Platform Pull source changes #

Documentation

Specifications

Other Resources

🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-1ab188a6-cc1f-490d-9413-9c6da20918d0?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-0e94f581-cbc1-48e0-b594-1f6b3d07a328?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-4517d93a-e7f7-4dc2-b572-06762bbe14de?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-88f9ddbb-3115-47dc-b6e5-7fc6f1d2a190?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-3a12caae-4945-4df4-8ab9-bb6219ba7a9f?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-863b18f0-c2f2-4e32-a5fa-0d1e6ccf77a9?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-189876d1-f207-49a2-a4bc-5c67ae78cd19?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-c1e74fd9-3f84-4d95-943d-d645d6cb82f7?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-b002164d-6e8a-4b6d-b409-4929476e7818?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-508660fd-30b8-4c9c-aede-8edbac8a514d?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-da35e0ba-f1a9-42fe-a77a-56ff0a47e341?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-1d4df7d0-9c92-4fa8-946f-2110c2b3b48d?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-2af6f54f-d259-46c0-8f86-78856f5885cd?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-cc203f31-e7f6-42ec-ad34-c5c4cde58904?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-f19285da-48dd-4691-bbdf-f7d6bec157a3?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-aa69cacc-4bbf-4724-a1d4-78cdad57fee8?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-a5858f86-04d3-4e15-ae11-b42c7516688b?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-c2052341-766c-43c7-b1dc-ed4985e4606b?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-aa777c90-8271-4809-8eac-3ec39a9a899c?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-4d5957dc-df05-4216-a5fc-d46b3ba811d8?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-28d97617-fdba-46a5-ac3e-40f3d2e0fa57?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-7429b451-d812-4abc-b497-b763372cf5c5?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-b0eafdd0-adaa-48a2-a855-6a31beb86d83?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-209f34ef-13c1-400c-bca8-fcddb304aff5?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-fb2bbbb8-d4cc-48b1-a660-c8e158bfbbea?action=share&creator=35240

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/engineering-platform-forks-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

engineering-platform-forks-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: APIs.io Engineering Platform Postman Forks 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: Forks
  description: The **Forks** endpoints enable you to manage element [forks](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/forking-elements/). Forks are new instances of an element that you can change without making any changes to the parent element.
paths:
  /collections/fork/{collectionId}:
    parameters:
    - $ref: '#/components/parameters/collectionId'
    post:
      summary: APIs.io Engineering Platform Create a fork
      description: Creates a [fork](https://learning.postman.com/docs/collaborating-in-postman/version-control/#creating-a-fork) from an existing collection into a workspace.
      operationId: createCollectionFork
      tags:
      - Forks
      requestBody:
        $ref: '#/components/requestBodies/createCollectionFork'
      responses:
        '200':
          $ref: '#/components/responses/createCollectionFork'
        '401':
          $ref: '#/components/responses/common401Error'
        '404':
          $ref: '#/components/responses/instanceNotFoundCollection'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
      parameters:
      - $ref: '#/components/parameters/forkWorkspaceQuery'
  /collections/merge:
    post:
      summary: APIs.io Engineering Platform Merge a fork
      description: Merges a forked collection back into its parent collection. You must have the [Editor role](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#collection-roles) for the collection to merge a fork.
      operationId: mergeCollectionFork
      tags:
      - Forks
      requestBody:
        $ref: '#/components/requestBodies/mergeCollectionFork'
      responses:
        '200':
          $ref: '#/components/responses/mergeCollectionFork'
        '401':
          $ref: '#/components/responses/common401Error'
        '403':
          $ref: '#/components/responses/common403ErrorForbiddenError'
        '404':
          $ref: '#/components/responses/instanceNotFoundCollection'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
  /collections/{collectionId}/collection-forks:
    parameters:
    - $ref: '#/components/parameters/collectionId'
    get:
      summary: APIs.io Engineering Platform Get all forked collections
      description: Gets a list of all the authenticated user's forked collections.
      operationId: getCollectionsForkedByUser
      tags:
      - Forks
      responses:
        '200':
          $ref: '#/components/responses/getCollectionsForkedByUser'
        '400':
          $ref: '#/components/responses/fork400ErrorNoUserFound'
        '401':
          $ref: '#/components/responses/common401Error'
        '500':
          $ref: '#/components/responses/common500Error'
      parameters:
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/createdAtSort'
  /collections/{collectionId}/forks:
    parameters:
    - $ref: '#/components/parameters/collectionId'
    get:
      summary: APIs.io Engineering Platform Get a collection's forks
      description: Gets a collection's forked collections. The response returns data for each fork, such as the fork's ID, the user who forked it, and the fork's creation date.
      operationId: getCollectionForks
      tags:
      - Forks
      responses:
        '200':
          $ref: '#/components/responses/getCollectionForks'
        '400':
          $ref: '#/components/responses/forkCollection400ErrorNoForks'
        '404':
          $ref: '#/components/responses/fork404Error'
        '500':
          $ref: '#/components/responses/common500Error'
      parameters:
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/createdAtSort'
  /collections/{collectionId}/pulls:
    parameters:
    - $ref: '#/components/parameters/collectionId'
    put:
      summary: APIs.io Engineering Platform Pull source changes
      description: 'Pulls the changes from a parent (source) collection into the forked collection. In the endpoint''s response:


        - The `destinationId` is the ID of the forked collection.

        - The `sourceId` is the ID of the source collection.

        '
      operationId: pullCollectionChanges
      tags:
      - Forks
      responses:
        '200':
          $ref: '#/components/responses/pullCollectionChanges'
        '400':
          $ref: '#/components/responses/forkCollection400ErrorBadId'
        '404':
          $ref: '#/components/responses/instanceNotFoundCollection'
        '500':
          $ref: '#/components/responses/common500Error'
  /collections/{collectionId}/source-status:
    parameters:
    - $ref: '#/components/parameters/collectionId'
    get:
      summary: APIs.io Engineering Platform Get source collection's status
      description: 'Checks whether there is a change between the forked collection and its parent (source) collection.


        If the value of the `isSourceAhead` property is `true` in the response, then there is a difference between the forked collection and its source collection.


        **Note:**


        This endpoint may take a few minutes to return an updated `isSourceAhead` status.

        '
      operationId: getSourceCollectionStatus
      tags:
      - Forks
      responses:
        '200':
          $ref: '#/components/responses/getSourceCollectionStatus'
        '400':
          $ref: '#/components/responses/forkCollection400ErrorNotForked'
        '500':
          $ref: '#/components/responses/common500Error'
  /environments/{environmentId}/forks:
    parameters:
    - $ref: '#/components/parameters/environmentUid'
    post:
      summary: APIs.io Engineering Platform Create a fork
      description: Creates a [fork](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/forking-elements/) of an existing environment.
      operationId: forkEnvironment
      tags:
      - Forks
      requestBody:
        $ref: '#/components/requestBodies/forkEnvironment'
      responses:
        '200':
          $ref: '#/components/responses/forkEnvironment'
        '401':
          $ref: '#/components/responses/common401Error'
        '404':
          $ref: '#/components/responses/environmentForks404Error'
        '500':
          $ref: '#/components/responses/common500Error'
      parameters:
      - $ref: '#/components/parameters/workspaceIdQueryTrue'
    get:
      summary: APIs.io Engineering Platform Get an environment's forks
      description: Gets all of an environment's forked environments.
      operationId: getEnvironmentForks
      tags:
      - Forks
      responses:
        '200':
          $ref: '#/components/responses/getEnvironmentForks'
        '400':
          $ref: '#/components/responses/environmentForks400Error'
        '401':
          $ref: '#/components/responses/common401Error'
        '404':
          $ref: '#/components/responses/environmentForks404Error'
        '500':
          $ref: '#/components/responses/common500Error'
      parameters:
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/directionQuery'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/sortByCreatedAt'
  /environments/{environmentId}/merges:
    parameters:
    - $ref: '#/components/parameters/environmentUid'
    post:
      summary: APIs.io Engineering Platform Merge a fork
      description: '[Merges](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/forking-elements/#merge-changes-from-a-fork) a forked environment back into its parent environment.

        '
      operationId: mergeEnvironmentFork
      tags:
      - Forks
      requestBody:
        $ref: '#/components/requestBodies/mergeEnvironmentFork'
      responses:
        '200':
          $ref: '#/components/responses/mergeEnvironmentFork'
        '400':
          $ref: '#/components/responses/environmentForks400Error'
        '401':
          $ref: '#/components/responses/common401Error'
        '404':
          $ref: '#/components/responses/environmentForks404Error'
        '500':
          $ref: '#/components/responses/common500Error'
  /environments/{environmentId}/pulls:
    parameters:
    - $ref: '#/components/parameters/environmentUid'
    post:
      summary: APIs.io Engineering Platform Pull source changes
      description: '[Pulls](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/forking-elements/#pull-updates-from-a-parent-element) the changes from a parent (source) environment into the forked environment.

        '
      operationId: pullEnvironment
      tags:
      - Forks
      requestBody:
        $ref: '#/components/requestBodies/pullEnvironment'
      responses:
        '200':
          $ref: '#/components/responses/pullEnvironment'
        '400':
          $ref: '#/components/responses/environmentForks400Error'
        '401':
          $ref: '#/components/responses/common401Error'
        '404':
          $ref: '#/components/responses/environmentForks404Error'
        '500':
          $ref: '#/components/responses/common500Error'
components:
  responses:
    forkEnvironment:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              environment:
                type: object
                description: Information about the forked environment.
                properties:
                  uid:
                    type: string
                    format: uid
                    description: The forked environment's ID.
                    example: 12345678-0fcea3ba-abcf-49c3-9f48-669c208fef25
                  name:
                    type: string
                    description: The name of the forked environment.
                    example: Testing Environment
                  forkName:
                    type: string
                    description: The forked environment's label.
                    example: Test Fork
          example:
            environment:
              uid: 12345678-0fcea3ba-abcf-49c3-9f48-669c208fef25
              name: Testing Environment
              forkName: Test Fork
    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
    fork400ErrorNoUserFound:
      description: Bad Request
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  name:
                    type: string
                    description: The error name.
                    example: badRequest
                  message:
                    type: string
                    description: The error message.
                    example: No Postman User found for given filters
          example:
            collection:
              name: badRequest
              message: No Postman User found for given filters
    forkCollection400ErrorNotForked:
      description: Bad Request
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  name:
                    type: string
                    description: The error name.
                    example: badRequest
                  message:
                    type: string
                    description: The error message.
                    example: The collection is not a forked collection.
          example:
            collection:
              name: badRequest
              message: The collection is not a forked collection.
    fork404Error:
      description: Not Found
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  name:
                    type: string
                    description: The error name.
                    example: notFoundError
                  message:
                    type: string
                    description: The error message.
                    example: Fork not found.
          example:
            collection:
              name: notFoundError
              message: Fork not found.
    common500Error:
      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 Server Error
              detail:
                type: string
                description: Information about the error.
                example: Internal Server Error
          example:
            type: https://api.postman.com/problems/internal-server-error
            title: Internal Server Error
            detail: Internal Server Error
    getCollectionsForkedByUser:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                type: array
                description: A list of the user's forked collections.
                items:
                  type: object
                  description: Information about the forked collection.
                  properties:
                    forkName:
                      type: string
                      description: The forked collection's label.
                      example: Collection Fork
                    forkId:
                      type: string
                      format: uid
                      description: The forked collection's ID.
                      example: 12345678-667df1ad-2ee3-7890-b678-7742d82e2e1f
                    sourceId:
                      type: string
                      description: The ID of the forked collection's source collection.
                      example: 87654321-bd46b634-b347-44d4-aa23-8c71ff4ecc4d
                    createdAt:
                      type: string
                      format: date-time
                      description: The date and time at which the fork was created.
                      example: '2023-11-16T09:18:17.000Z'
              meta:
                type: object
                description: The response's meta information for paginated results.
                properties:
                  total:
                    type: number
                    description: The total number of forked collections.
                    example: 2
                  nextCursor:
                    type:
                    - string
                    - 'null'
                    format: base64
                    description: The pagination cursor that points to the next record in the results set.
                    example: eyJpZCI6MzMyNzksImZvcmtzQWZ0ZXIiOjIwfQ==
                  inaccessibleFork:
                    type: number
                    description: The total number of forked collections that the user cannot access.
                    example: 0
          example:
            data:
            - forkName: Collection Fork
              forkId: 12345678-667df1ad-2ee3-7890-b678-7742d82e2e1f
              sourceId: 87654321-bd46b634-b347-44d4-aa23-8c71ff4ecc4d
              createdAt: '2023-11-16T09:18:17.000Z'
            - forkName: Test Fork
              forkId: 12345678-38j9f1ad-2ee3-7890-dv5h-7742d82e2e1f
              sourceId: 87654321-bd46b634-b347-44d4-aa23-8c71ff4ecc4d
              createdAt: '2023-11-16T09:16:15.000Z'
            meta:
              total: 2
              nextCursor: null
              inaccessibleFork: 0
    createCollectionFork:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              collection:
                type: object
                description: Information about the forked collection.
                properties:
                  id:
                    type: string
                    description: The forked collection's ID.
                    example: 09547fef-a9a5-4e00-998b-aa563e8db69a
                  name:
                    type: string
                    description: The collection's name.
                    example: Test Collection
                  fork:
                    type: object
                    description: Information about the collection's fork.
                    properties:
                      label:
                        type: string
                        description: The fork's label.
                        example: Test Fork
                      createdAt:
                        type: string
                        format: date-time
                        description: The fork's creation date and time.
                        example: '2022-06-16T19:51:44.069Z'
                      from:
                        type: string
                        format: uid
                        description: The unique ID of fork's source collection.
                        example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
                  uid:
                    type: string
                    format: uid
                    description: The forked collection's unique ID.
                    example: 12345678-09547fef-a9a5-4e00-998b-aa563e8db69a
          example:
            collection:
              id: 09547fef-a9a5-4e00-998b-aa563e8db69a
              name: Test Collection
              fork:
                label: Test Fork
                createdAt: '2022-06-16T19:51:44.069Z'
                from: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
              uid: 12345678-09547fef-a9a5-4e00-998b-aa563e8db69a
    getCollectionForks:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                type: array
                description: A list of the collection's forks.
                items:
                  type: object
                  description: Information about the forked collection.
                  properties:
                    createdAt:
                      type: string
                      format: date-time
                      description: The date and time at which the fork was created.
                      example: '2023-11-16T09:18:17.000Z'
                    createdBy:
                      type: string
                      description: The user who created the collection fork.
                      example: Taylor Lee
                    forkId:
                      type: string
                      format: uid
                      description: The forked collection's ID.
                      example: 12345678-667df1ad-2ee3-7890-b678-7742d82e2e1f
                    forkName:
                      type: string
                      description: The forked collection's label.
                      example: Collection Fork
              meta:
                type: object
                description: The response's meta information for paginated results.
                properties:
                  nextCursor:
                    type:
                    - string
                    - 'null'
                    format: base64
                    description: The pagination cursor that points to the next record in the results set.
                    example: eyJpZCI6MzMyNzksImZvcmtzQWZ0ZXIiOjIwfQ==
                  total:
                    type: number
                    description: The total number of forked collections.
                    example: 2
          example:
            data:
            - forkName: Collection Fork
              forkId: 12345678-667df1ad-2ee3-7890-b678-7742d82e2e1f
              createdBy: Taylor Lee
              createdAt: '2023-11-16T09:18:17.000Z'
            - forkName: Test Fork
              forkId: 87654321-38j9f1ad-2ee3-7890-dv5h-7742d82e2e1f
              createdBy: Alex Cruz
              createdAt: '2023-11-16T09:16:15.000Z'
            meta:
              total: 2
              nextCursor: null
    mergeCollectionFork:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              collection:
                type: object
                properties:
                  id:
                    type: string
                    description: The source collection's ID.
                    example: 12ece9e1-2abf-4edc-8e34-de66e74114d2
                  uid:
                    type: string
                    format: uid
                    description: The source collection's unique ID.
                    example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
          example:
            collection:
              id: 12ece9e1-2abf-4edc-8e34-de66e74114d2
              uid: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
    common500ErrorServerError:
      description: Internal Server Error
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  name:
                    type: string
                    description: The error name.
                    example: serverError
                  message:
                    type: string
                    description: The error message.
                    example: An error has occurred on the server.
          example:
            error:
              name: serverError
              message: An error has occurred on the server.
    forkCollection400ErrorNoForks:
      description: Bad Request
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  name:
                    type: string
                    description: The error name.
                    example: badRequest
                  message:
                    type: string
                    description: The error message.
                    example: This collection id has no forks.
          example:
            collection:
              name: badRequest
              message: This collection id has no forks.
    instanceNotFoundCollection:
      description: Instance 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 item does not exist.
                  details:
                    type: object
                    description: Information about the error.
                    properties:
                      item:
                        type: string
                        description: The instance item.
                        example: collection
                      id:
                        type: string
                        description: The collection ID.
                        example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
          example:
            error:
              name: instanceNotFoundError
              message: The specified item does not exist.
              details:
                item: collection
                id: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
    environmentForks400Error:
      description: Bad Request
      content:
        application/json:
          schema:
            type: object
            properties:
              type:
                type: string
                description: The type of error.
                example: https://api.postman.com/problems/bad-request
              title:
                type: string
                description: The title of the error message.
                example: The environment Id is not a forked environment.
              detail:
                type: object
                description: Details about the error message.
                example: {}
          examples:
            environmentNotForked:
              value:
                type: https://api.postman.com/problems/bad-request
                title: The environment Id is not a forked environment.
                detail: {}
    pullEnvironment:
      

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