APIs.io Engineering Platform Collections API

openapi: 3.2.0
info:
  title: APIs.io Engineering Platform Postman Collections 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: Collections
  description: The **Collections** endpoints enable you to manage your Postman [Collections](https://learning.postman.com/docs/sending-requests/intro-to-collections/).
paths:
  /apis/{apiId}/collections:
    parameters:
    - $ref: '#/components/parameters/apiId'
    - $ref: '#/components/parameters/v10Accept'
    post:
      summary: APIs.io Engineering Platform Add a collection
      description: "Adds a collection to an API. To do this, use the following `operationType` values:\n\n- `COPY_COLLECTION` — Copies a collection from the workspace and adds it to an API.\n- `CREATE_NEW` — Creates a new collection by providing the new collection's content.\n- `GENERATE_FROM_SCHEMA` — Generates the collection from an API schema.\n    - `options` — An object that contains advanced creation options and their values. You can find a complete list of properties and their values in Postman's [OpenAPI to Postman Collection Converter OPTIONS documentation](https://github.com/postmanlabs/openapi-to-postman/blob/develop/OPTIONS.md). These properties are case-sensitive.\n"
      operationId: addApiCollection
      tags:
      - Collections
      requestBody:
        $ref: '#/components/requestBodies/addApiCollection'
      responses:
        '200':
          $ref: '#/components/responses/addApiCollection'
        '400':
          $ref: '#/components/responses/v10HeaderMissing'
        '401':
          $ref: '#/components/responses/api401ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/apiSchema403ErrorForbidden'
                - $ref: '#/components/schemas/featureUnavailable403Error'
              examples:
                Forbidden:
                  $ref: '#/components/examples/apiSchema403ErrorForbidden'
                Feature Unavailable:
                  $ref: '#/components/examples/featureUnavailable403Error'
        '404':
          $ref: '#/components/responses/api404ErrorNotFound'
        '500':
          $ref: '#/components/responses/common500Error'
  /apis/{apiId}/collections/{collectionId}:
    parameters:
    - $ref: '#/components/parameters/apiId'
    - $ref: '#/components/parameters/collectionIdApi'
    - $ref: '#/components/parameters/v10Accept'
    get:
      summary: APIs.io Engineering Platform Get a collection
      description: 'Gets a collection attached to an API. You can use the `versionId` query parameter to get a collection published in a version.


        **Note:**


        - You cannot use this endpoint to get a Git-linked API collection. Collections in a Git-linked API are stored in the linked Git repository, not in the Postman cloud. This endpoint only has access to Postman servers.

        - You can get a collection published in an API version with the `versionId` query parameter.

        - The `versionId` query parameter is a required parameter for API viewers.

        '
      operationId: getApiCollection
      tags:
      - Collections
      responses:
        '200':
          $ref: '#/components/responses/getApiCollection'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/api400ErrorVersionIdMissing'
                - $ref: '#/components/schemas/v10HeaderMissing'
              examples:
                Version ID Missing:
                  $ref: '#/components/examples/api400ErrorVersionIdMissing'
                Missing v10 Accept Header:
                  $ref: '#/components/examples/v10HeaderMissing'
        '401':
          $ref: '#/components/responses/api401ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/api403ErrorAndFeatureUnavailable'
        '404':
          $ref: '#/components/responses/apiCollection404ErrorNotFound'
        '422':
          $ref: '#/components/responses/gitLinkedApi422Error'
        '500':
          $ref: '#/components/responses/common500Error'
      parameters:
      - $ref: '#/components/parameters/apiVersionQuery'
  /apis/{apiId}/collections/{collectionId}/sync-with-schema-tasks:
    parameters:
    - $ref: '#/components/parameters/apiId'
    - $ref: '#/components/parameters/collectionIdApi'
    - $ref: '#/components/parameters/v10Accept'
    put:
      summary: APIs.io Engineering Platform Sync collection with schema
      description: 'Syncs a collection attached to an API with the API schema.


        This is an asynchronous endpoint that returns an HTTP `202 Accepted` response. The response contains a polling link to the `/apis/{apiId}/tasks/{taskId}` endpoint in the `Location` header.


        **Note:**


        This endpoint only supports the OpenAPI 3 schema type.

        '
      operationId: syncCollectionWithSchema
      tags:
      - Collections
      responses:
        '202':
          $ref: '#/components/responses/syncCollectionWithSchema'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/apiCollection400InvalidParam'
                - $ref: '#/components/schemas/v10HeaderMissing'
              examples:
                Invalid Parameter:
                  $ref: '#/components/examples/apiCollection400InvalidParam'
                Missing v10 Accept Header:
                  $ref: '#/components/examples/v10HeaderMissing'
        '401':
          $ref: '#/components/responses/api401ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/apiSchema403ErrorForbidden'
                - $ref: '#/components/schemas/featureUnavailable403Error'
              examples:
                Forbidden:
                  $ref: '#/components/examples/apiSchema403ErrorForbidden'
                Feature Unavailable:
                  $ref: '#/components/examples/featureUnavailable403Error'
        '404':
          $ref: '#/components/responses/apiSchema404ErrorNotFound'
        '422':
          $ref: '#/components/responses/apiSchema422ErrorActionNotAllowed'
        '500':
          $ref: '#/components/responses/common500Error'
  /collection-access-keys:
    get:
      summary: APIs.io Engineering Platform Get collection access keys
      description: 'Gets the authenticated user''s personal and team [collection access keys](https://learning.postman.com/docs/developer/postman-api/authentication/#generate-a-collection-access-key).


        **Note:**


        - The `expiresAfter` property in the response represents the date and time at which the access key expires. Collection access keys are valid for 60 days. If unused, the access key expires after 60 days. If someone uses the access key, then its expiration date increases by another 60 days.

        - If the collection key is unused, the `lastUsedAt` property in the response returns an empty string.

        '
      operationId: getCollectionAccessKeys
      tags:
      - Collections
      responses:
        '200':
          $ref: '#/components/responses/getCollectionAccessKeys'
        '400':
          $ref: '#/components/responses/common400ErrorInvalidCursor'
        '401':
          $ref: '#/components/responses/common401Error'
        '403':
          $ref: '#/components/responses/common403ErrorForbidden'
        '500':
          $ref: '#/components/responses/common500ErrorSomethingWrong'
      parameters:
      - $ref: '#/components/parameters/collectionUidQuery'
      - $ref: '#/components/parameters/cursor'
  /collection-access-keys/{keyId}:
    delete:
      summary: APIs.io Engineering Platform Delete a collection access key
      description: 'Deletes a collection access key. To get a collection access key''s ID, use the GET `/collection-access-key` endpoint.


        On success, this returns an HTTP `204 No Content` response.

        '
      operationId: deleteCollectionAccessKey
      tags:
      - Collections
      responses:
        '204':
          description: No Content
        '401':
          $ref: '#/components/responses/common401Error'
        '403':
          $ref: '#/components/responses/common403ErrorForbidden'
        '404':
          $ref: '#/components/responses/cakNotFound404Error'
        '500':
          $ref: '#/components/responses/common500ErrorSomethingWrong'
      parameters:
      - $ref: '#/components/parameters/collectionAccessKeyId'
  /collections:
    get:
      summary: APIs.io Engineering Platform Get all collections
      description: Gets all of your [collections](https://www.getpostman.com/docs/collections). The response includes all of your subscribed collections.
      operationId: getCollections
      tags:
      - Collections
      responses:
        '200':
          $ref: '#/components/responses/getCollections'
        '401':
          $ref: '#/components/responses/common401Error'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
      parameters:
      - $ref: '#/components/parameters/workspaceQuery'
      - $ref: '#/components/parameters/collectionNameQuery'
    post:
      summary: APIs.io Engineering Platform Create a collection
      description: "Creates a collection using the [Postman Collection v2.1.0 schema format](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).\n\n**Note:**\n\n- If you do not include the `workspace` query parameter, the system creates the collection in your \"My Workspace\" workspace.\n- For a complete list of available property values for this endpoint, use the following references available in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html):\n    - `info` object — Refer to the **Information** entry.\n    - `item` object — Refer to the **Items** entry.\n- For all other possible values, refer to the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).\n"
      operationId: createCollection
      tags:
      - Collections
      requestBody:
        $ref: '#/components/requestBodies/createCollection'
      responses:
        '200':
          $ref: '#/components/responses/createCollection'
        '400':
          $ref: '#/components/responses/collection400ErrorInstanceFound'
        '401':
          $ref: '#/components/responses/common401Error'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
      parameters:
      - $ref: '#/components/parameters/workspaceQuery'
  /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:
      - Collections
      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:
      - Collections
      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}:
    parameters:
    - $ref: '#/components/parameters/collectionId'
    get:
      summary: APIs.io Engineering Platform Get a collection
      description: Gets information about a collection. For a complete list of this endpoint's possible values, refer to the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).
      operationId: getCollection
      tags:
      - Collections
      responses:
        '200':
          $ref: '#/components/responses/getCollection'
        '400':
          $ref: '#/components/responses/collection400ErrorCollectionNotFound'
        '401':
          $ref: '#/components/responses/common401Error'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
      parameters:
      - $ref: '#/components/parameters/collectionAccessKeyQuery'
      - $ref: '#/components/parameters/collectionModelQuery'
    put:
      summary: APIs.io Engineering Platform Replace a collection's data
      description: 'Replaces the contents of a collection using the [Postman Collection v2.1.0 schema format](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). Include the collection''s ID values in the request body. If you do not, the endpoint removes the existing items and creates new items.


        > The maximum collection size this endpoint accepts cannot exceed 20 MB.


        For a complete list of available property values for this endpoint, use the following references available in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html):

        - `info` object — Refer to the **Information** entry.

        - `item` object — Refer to the **Items** entry.


        For all other possible values, refer to the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).


        **Note:**


        To copy another collection''s contents to the given collection, remove all ID values before you pass it in this endpoint. If you do not, this endpoint returns an error. These values include the `id`, `uid`, and `postman_id` values.

        '
      operationId: putCollection
      tags:
      - Collections
      requestBody:
        $ref: '#/components/requestBodies/putCollection'
      responses:
        '200':
          $ref: '#/components/responses/putCollection'
        '400':
          $ref: '#/components/responses/collection400ErrorMalformedRequest'
        '401':
          $ref: '#/components/responses/common401Error'
        '403':
          $ref: '#/components/responses/common403Error'
        '404':
          $ref: '#/components/responses/instanceNotFoundCollection'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
    patch:
      summary: APIs.io Engineering Platform Update part of a collection
      description: 'Updates specific collection information, such as its name, events, or its variables. For more information about the `auth`, `variables`, and `events` properties, refer to the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html):

        - For `variables`, refer to the **Variable List** entry.

        - For `auth`, refer to the **Auth** entry.

        - For `events`, refer to the **Event List** entry.

        '
      operationId: patchCollection
      tags:
      - Collections
      requestBody:
        $ref: '#/components/requestBodies/patchCollection'
      responses:
        '200':
          $ref: '#/components/responses/patchCollection'
        '400':
          $ref: '#/components/responses/collection400ErrorInvalidKeyParam'
        '401':
          $ref: '#/components/responses/common401Error'
        '403':
          $ref: '#/components/responses/common403Error'
        '404':
          $ref: '#/components/responses/instanceNotFoundCollection'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
    delete:
      summary: APIs.io Engineering Platform Delete a collection
      description: Deletes a collection.
      operationId: deleteCollection
      tags:
      - Collections
      responses:
        '200':
          $ref: '#/components/responses/deleteCollection'
        '401':
          $ref: '#/components/responses/common401Error'
        '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:
      - Collections
      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}/comments:
    parameters:
    - $ref: '#/components/parameters/collectionUid'
    get:
      summary: APIs.io Engineering Platform Get a collection's comments
      description: Gets all comments left by users in a collection.
      operationId: getCollectionComments
      tags:
      - Collections
      responses:
        '200':
          $ref: '#/components/responses/commentGet'
        '401':
          $ref: '#/components/responses/comment401Error'
        '403':
          $ref: '#/components/responses/comment403Error'
        '404':
          $ref: '#/components/responses/comment404Error'
        '500':
          $ref: '#/components/responses/comment500Error'
    post:
      summary: APIs.io Engineering Platform Create a collection comment
      description: 'Creates a comment on a collection.


        **Note:**


        This endpoint accepts a max of 10,000 characters.

        '
      tags:
      - Collections
      operationId: createCollectionComment
      requestBody:
        $ref: '#/components/requestBodies/commentCreateUpdate'
      responses:
        '201':
          $ref: '#/components/responses/commentCreated'
        '401':
          $ref: '#/components/responses/comment401Error'
        '403':
          $ref: '#/components/responses/comment403Error'
        '404':
          $ref: '#/components/responses/comment404Error'
        '500':
          $ref: '#/components/responses/comment500Error'
  /collections/{collectionId}/comments/{commentId}:
    parameters:
    - $ref: '#/components/parameters/collectionUid'
    - $ref: '#/components/parameters/commentId'
    put:
      summary: APIs.io Engineering Platform Update a collection's comment
      description: 'Updates a comment on a collection.


        **Note:**


        This endpoint accepts a max of 10,000 characters.

        '
      operationId: updateCollectionComment
      tags:
      - Collections
      requestBody:
        $ref: '#/components/requestBodies/commentCreateUpdate'
      responses:
        '200':
          $ref: '#/components/responses/commentUpdated'
        '401':
          $ref: '#/components/responses/comment401Error'
        '403':
          $ref: '#/components/responses/comment403Error'
        '404':
          $ref: '#/components/responses/comment404Error'
        '500':
          $ref: '#/components/responses/comment500Error'
    delete:
      summary: APIs.io Engineering Platform Delete a collection's comment
      description: 'Deletes a comment from a collection. On success, this returns an HTTP `204 No Content` response.


        **Note:**


        Deleting the first comment of a thread deletes all the comments in the thread.

        '
      operationId: deleteCollectionComment
      tags:
      - Collections
      responses:
        '204':
          description: No Content
        '401':
          $ref: '#/components/responses/comment401Error'
        '403':
          $ref: '#/components/responses/comment403Error'
        '404':
          $ref: '#/components/responses/comment404Error'
        '500':
          $ref: '#/components/responses/comment500Error'
  /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:
      - Collections
      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:
      - Collections
      responses:
        '200':
          $ref: '#/components/responses/pullCollectionChanges'
        '400':
          $ref: '#/components/responses/forkCollection400ErrorBadId'
        '404':
          $ref: '#/components/responses/instanceNotFoundCollection'
        '500':
          $ref: '#/components/responses/common500Error'
  /collections/{collectionId}/pull-requests:
    parameters:
    - $ref: '#/components/parameters/collectionUid'
    get:
      summary: APIs.io Engineering Platform Get a collection's pull requests
      description: Gets information about a collection's pull requests, such as the source and destination IDs, status of the pull requests, and a URL link to the pull requests.
      operationId: getCollectionPullRequests
      tags:
      - Collections
      responses:
        '200':
          $ref: '#/components/responses/getCollectionPullRequests'
        '403':
          $ref: '#/components/responses/pullRequest403ErrorRolePermissionsCollection'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
    post:
      summary: APIs.io Engineering Platform Create a pull request
      description: Creates a pull request for a forked collection into its parent collection.
      operationId: createCollectionPullRequest
      tags:
      - Collections
      requestBody:
        $ref: '#/components/requestBodies/pullRequestCreate'
      responses:
        '200':
          $ref: '#/components/responses/pullRequestCreated'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/forkCollection400ErrorBadForkRelation'
                - $ref: '#/components/schemas/pullRequest400ErrorDuplicate'
              examples:
                Invalid Fork Source:
                  $ref: '#/components/examples/forkCollection400ErrorBadForkRelation'
                Pull Request Already Exists:
                  $ref: '#/components/examples/pullRequest400ErrorDuplicate'
        '403':
          $ref: '#/components/responses/pullRequest403ErrorNoViewerAccessCollections'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
  /collections/{collectionId}/roles:
    parameters:
    - $ref: '#/components/parameters/collectionId'
    get:
      summary: APIs.io Engineering Platform Get a collection's roles
      description: Gets information about all roles in a collection. The response returns the IDs of all users, teams, and groups with access to view or edit the collection.
      operationId: getCollectionRoles
      tags:
      - Collections
      responses:
        '200':
          $ref: '#/components/responses/getCollectionRoles'
        '401':
          $ref: '#/components/responses/unauthorizedError'
        '403':
          $ref: '#/components/responses/common403ErrorPermissions'
        '404':
          $ref: '#/components/responses/collection404ErrorInstanceNotFound'
        '500':
          $ref: '#/components/responses/common500ErrorInternalServer'
    patch:
      summary: APIs.io Engineering Platform Update a collection's roles
      description: 'Updates the roles of users, groups, or teams in a collection. On success, this returns an HTTP `204 No Content` response.


        **Note:**


        - Only users assigned the EDITOR [role](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#collection-roles) in the collection can use this endpoint.

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

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