APIs.io Engineering Platform Collection Requests API

openapi: 3.2.0
info:
  title: APIs.io Engineering Platform Postman Collection Requests 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: Collection Requests
  description: The **Collection Requests** endpoints enable you to manage collection requests.
paths:
  /collections/{collectionId}/requests:
    parameters:
    - $ref: '#/components/parameters/collectionId'
    post:
      summary: APIs.io Engineering Platform Create a request
      description: 'Creates a request in a collection. For a complete list of properties, refer to the **Request** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).


        **Note:**


        It is recommended that you pass the `name` property in the request body. If you do not, the system uses a null value. As a result, this creates a request with a blank name.

        '
      operationId: createCollectionRequest
      tags:
      - Collection Requests
      requestBody:
        $ref: '#/components/requestBodies/createCollectionRequest'
      responses:
        '200':
          $ref: '#/components/responses/createCollectionRequest'
        '400':
          $ref: '#/components/responses/collectionRequest400Error'
        '401':
          $ref: '#/components/responses/collectionRequest401Error'
        '500':
          $ref: '#/components/responses/common500Error'
      parameters:
      - $ref: '#/components/parameters/collectionRequestFolderIdQuery'
  /collections/{collectionId}/requests/{requestId}/comments:
    parameters:
    - $ref: '#/components/parameters/collectionUid'
    - $ref: '#/components/parameters/collectionRequestUid'
    get:
      summary: APIs.io Engineering Platform Get a request's comments
      description: Gets all comments left by users in a request.
      operationId: getRequestComments
      tags:
      - Collection Requests
      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 request comment
      description: 'Creates a comment on a request.


        **Note:**


        This endpoint accepts a max of 10,000 characters.

        '
      tags:
      - Collection Requests
      operationId: createRequestComment
      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}/requests/{requestId}/comments/{commentId}:
    parameters:
    - $ref: '#/components/parameters/collectionUid'
    - $ref: '#/components/parameters/collectionRequestUid'
    - $ref: '#/components/parameters/commentId'
    put:
      summary: APIs.io Engineering Platform Update a request's comment
      description: 'Updates a comment on a request.


        **Note:**


        This endpoint accepts a max of 10,000 characters.

        '
      operationId: updateRequestComment
      tags:
      - Collection Requests
      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 request's comment
      description: 'Deletes a comment from a request. 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: deleteRequestComment
      tags:
      - Collection Requests
      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}/requests/{requestId}:
    parameters:
    - $ref: '#/components/parameters/collectionRequestId'
    - $ref: '#/components/parameters/collectionId'
    get:
      summary: APIs.io Engineering Platform Get a request
      description: Gets information about a request in a collection.
      operationId: getCollectionRequest
      tags:
      - Collection Requests
      responses:
        '200':
          $ref: '#/components/responses/getCollectionRequest'
        '401':
          $ref: '#/components/responses/collectionRequest401Error'
        '404':
          $ref: '#/components/responses/collectionRequest404Error'
        '500':
          $ref: '#/components/responses/common500Error'
      parameters:
      - $ref: '#/components/parameters/collectionItemsIdQuery'
      - $ref: '#/components/parameters/collectionItemsUidFormatQuery'
      - $ref: '#/components/parameters/collectionItemsPopulateQuery'
    put:
      summary: APIs.io Engineering Platform Update a request
      description: 'Updates a request in a collection. For a complete list of properties, refer to the **Request** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).


        **Note:**


        - You must pass a collection ID (`12ece9e1-2abf-4edc-8e34-de66e74114d2`), not a collection(`12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2`), in this endpoint.

        - This endpoint does not support changing the folder of a request.

        '
      operationId: updateCollectionRequest
      tags:
      - Collection Requests
      requestBody:
        $ref: '#/components/requestBodies/updateCollectionRequest'
      responses:
        '200':
          $ref: '#/components/responses/updateCollectionRequest'
        '400':
          $ref: '#/components/responses/collectionRequest400Error'
        '401':
          $ref: '#/components/responses/collectionRequest401Error'
        '404':
          $ref: '#/components/responses/collectionRequest404Error'
        '500':
          $ref: '#/components/responses/common500Error'
    delete:
      summary: APIs.io Engineering Platform Delete a request
      description: Deletes a request in a collection.
      operationId: deleteCollectionRequest
      tags:
      - Collection Requests
      responses:
        '200':
          $ref: '#/components/responses/deleteCollectionRequest'
        '401':
          $ref: '#/components/responses/collectionRequest401Error'
        '404':
          $ref: '#/components/responses/collectionRequest404Error'
        '500':
          $ref: '#/components/responses/common500Error'
components:
  responses:
    createCollectionRequest:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                type: object
                additionalProperties: true
                description: Information about the created request. For a complete list of properties, refer to the **Request** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).
                properties:
                  id:
                    type: string
                    description: The request's ID.
                    example: c82dd02c-4870-4907-8fcb-593a876cf05b
                  name:
                    type: string
                    description: The request's name.
                    example: Test Request
                  owner:
                    type: string
                    description: The user ID of the request's owner.
                    example: '12345678'
                  folder:
                    type:
                    - string
                    - 'null'
                    description: Information about the request's parent folder.
                    example: null
                  responses:
                    type: array
                    description: A list of the request's responses.
                    items:
                      type: string
                    example: []
                  collection:
                    type: string
                    description: The collection ID that the request belongs to.
                    example: 12ece9e1-2abf-4edc-8e34-de66e74114d2
                  responses_order:
                    type: array
                    description: A list of response IDs and their order in the folder.
                    items:
                      type: string
                    uniqueItems: true
                    example: []
                  createdAt:
                    type: string
                    format: date-time
                    description: The requeset's creation date and time.
                    example: '2022-08-29T16:35:38.831Z'
                  updatedAt:
                    type: string
                    format: date-time
                    description: The date and time at which the request was last updated.
                    example: '2022-08-29T16:35:38.831Z'
                  lastUpdatedBy:
                    type: string
                    description: The user ID of the user that last updated the folder.
                    example: '12345678'
              meta:
                type: object
                description: A Postman-specific response that contains information about the internal performed operation.
                additionalProperties: true
              model_id:
                type: string
                description: The request's ID.
                example: c82dd02c-4870-4907-8fcb-593a876cf05b
              revision:
                type: number
                description: An internal revision ID. Its value increments each time the resource changes. You can use this ID to track whether there were changes since the last time you fetched the resource.
                example: 26531992398
          example:
            model_id: c82dd02c-4870-4907-8fcb-593a876cf05b
            meta:
              model: request
              action: import
            data:
              collection: 12ece9e1-2abf-4edc-8e34-de66e74114d2
              method: GET
              headers:
              - key: Host
                value: postman-echo.com
              - key: user-agent
                value: curl/7.88.1
              - key: accept
                value: '*/*'
              - key: content-type
                value: application/json
              dataMode: raw
              url: https://postman-echo.com/get?param=value
              name: Example GET Request
              description: This is an example GET request.
              owner: '12345678'
              folder: null
              responses_order: []
              id: c82dd02c-4870-4907-8fcb-593a876cf05b
              lastUpdatedBy: '12345678'
              queryParams:
              - key: id
                value: '{{id}}'
                equals: true
                description: Optional. The user's ID.
                enabled: true
              headerData: []
              createdAt: '2023-09-07T13:33:17.912Z'
              updatedAt: '2023-09-07T13:33:17.912Z'
              rawModeData: null
              dataOptions:
                raw:
                  language: json
              responses: []
            revision: 32456338071
    deleteCollectionRequest:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              model_id:
                type: string
                description: The request's ID.
                example: c82dd02c-4870-4907-8fcb-593a876cf05b
              meta:
                type: object
                description: A Postman-specific response that contains information about the internal performed operation.
                additionalProperties: true
              data:
                type: object
                description: The request's information.
                properties:
                  id:
                    type: string
                    description: The request's ID.
                    example: c82dd02c-4870-4907-8fcb-593a876cf05b
                  owner:
                    type: string
                    description: The user ID of the request's owner.
                    example: '12345678'
              revision:
                type: number
                description: An internal revision ID. Its value increments each time the resource changes. You can use this ID to track whether there were changes since the last time you fetched the resource.
                example: 24995158577
          example:
            model_id: c82dd02c-4870-4907-8fcb-593a876cf05b
            meta:
              model: request
              action: destroy
            data:
              id: c82dd02c-4870-4907-8fcb-593a876cf05b
              owner: '12345678'
            revision: 24995158577
    commentGet:
      description: Successful Response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/commentResponse'
          example:
            data:
            - id: 46818
              threadId: 12345
              createdBy: 12345678
              createdAt: '2024-01-18T12:00:54.000Z'
              updatedAt: '2024-01-18T12:00:54.000Z'
              body: This is also an example.
            - id: 46817
              threadId: 67890
              createdBy: 87654321
              createdAt: '2024-01-18T11:48:01.000Z'
              updatedAt: '2024-01-18T11:48:01.000Z'
              body: Another example.
            - id: 46814
              threadId: 23456
              createdBy: 12345678
              createdAt: '2024-01-18T11:30:40.000Z'
              updatedAt: '2024-01-18T11:30:40.000Z'
              body: This is an example.
    commentUpdated:
      description: Successful Response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/commentCreatedUpdated'
          example:
            data:
              id: 46814
              threadId: 12345
              createdBy: 12345678
              createdAt: '2024-01-18T11:30:40.000Z'
              updatedAt: '2024-01-18T11:30:40.000Z'
              body: This is an updated example.
    comment401Error:
      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
    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
    commentCreated:
      description: Created
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/commentCreatedUpdated'
          example:
            data:
              id: 46814
              createdBy: 12345678
              createdAt: '2024-01-18T11:30:40.000Z'
              updatedAt: '2024-01-18T11:30:40.000Z'
              body: This is an example.
    comment500Error:
      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
              status:
                type: integer
                format: http-status-code
                description: The error's HTTP status code.
                example: 500
          example:
            type: https://api.postman.com/problems/internal-server-error
            title: Internal Server Error
            detail: Internal Server Error
            status: 500
    updateCollectionRequest:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                type: object
                additionalProperties: true
                description: Information about the updated request. For a complete list of properties, refer to the **Request** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).
                properties:
                  id:
                    type: string
                    description: The request's ID.
                    example: c82dd02c-4870-4907-8fcb-593a876cf05b
                  name:
                    type: string
                    description: The request's name.
                    example: Example GET request
                  description:
                    type: string
                    description: The request's description.
                    example: This is an example GET request.
                  createdAt:
                    type: string
                    format: date-time
                    description: The request's creation date and time.
                    example: '2022-08-29T16:49:19.964Z'
                  updatedAt:
                    type: string
                    format: date-time
                    description: The date and time at which the request was last updated.
                    example: '2022-08-29T16:49:19.964Z'
                  owner:
                    type: string
                    description: The user ID of the request's owner.
                    example: '12345678'
                  lastUpdatedBy:
                    type: string
                    description: The user ID of the user that last updated the request.
                    example: '12345678'
                  lastRevision:
                    type: integer
                    format: int64
                    example: 24994863800
                    description: An internal revision ID. Its value increments each time the resource changes. You can use this ID to track whether there were changes since the last time you fetched the resource.
              meta:
                type: object
                description: A Postman-specific response that contains information about the internal performed operation.
                additionalProperties: true
              model_id:
                type: string
                description: The request's ID.
                example: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa
              revision:
                type: number
                description: An internal revision ID. Its value increments each time the resource changes. You can use this ID to track whether there were changes since the last time you fetched the resource.
                example: 24994954828
          example:
            model_id: c82dd02c-4870-4907-8fcb-593a876cf05b
            meta:
              model: request
              action: update
            data:
              id: c82dd02c-4870-4907-8fcb-593a876cf05b
              name: Example POST Request
              dataMode: raw
              data: null
              auth: noauth
              events: null
              rawModeData: "{\n    \"field\": \"Value\"\n}"
              descriptionFormat: null
              description: This is an example POST request.
              variables: null
              headers: null
              method: POST
              pathVariables: null
              url: https://postman-echo.com/post
              preRequestScript: null
              tests: null
              currentHelper: null
              helperAttributes: null
              queryParams: []
              headerData: []
              pathVariableData: []
              protocolProfileBehavior: null
              dataDisabled: false
              responses_order: []
              createdAt: '2023-09-01T07:59:25.000Z'
              updatedAt: '2023-09-08T12:30:29.000Z'
              owner: '12345678'
              lastUpdatedBy: '12345678'
              lastRevision: 32473087936
              folder: null
              collection: 12ece9e1-2abf-4edc-8e34-de66e74114d2
              dataOptions:
                raw:
                  language: json
            revision: 32473098909
    comment403Error:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/comment403Error'
          example:
            type: https://api.postman.com/problems/forbidden
            title: Forbidden
            detail: Forbidden
            status: 403
    comment404Error:
      description: Not Found
      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/not-found
              title:
                type: string
                description: A short summary of the problem.
                example: Not Found
              detail:
                type: string
                description: Information about the error.
                example: Not Found
              status:
                type: integer
                format: http-status-code
                description: The error's HTTP status code.
                example: 404
          example:
            type: https://api.postman.com/problems/not-found
            title: Not Found
            detail: Not Found
            status: 404
    collectionRequest404Error:
      description: Not Found
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  name:
                    type: string
                    description: The error name.
                    example: instanceNotFoundError
                  details:
                    type: object
                    description: Information about the error.
                    properties:
                      model:
                        type: string
                        description: The resource name.
                        example: request
                      owner:
                        type: string
                        description: The user ID of the request's owner.
                        example: '12345678'
                      model_id:
                        type: string
                        description: The request's ID.
                        example: c82dd02c-4870-4907-8fcb-593a876cf05b
                  message:
                    type: string
                    description: The error message.
                    example: We could not find the request you are looking for
          example:
            error:
              name: instanceFoundError
              details:
                model: request
                owner: '12345678'
                model_id: c82dd02c-4870-4907-8fcb-593a876cf05b
              message: We could not find the request you are looking for
    collectionRequest400Error:
      description: Bad Request
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              error:


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