Postman collectionItems API

openapi: 3.2.0
info:
  title: Postman Collection Items API
  version: 1.0.0
servers:
- url: https://api.postman.com
  description: https://api.postman.com
- url: https://api.eu.postman.com
  description: https://api.eu.postman.com
tags:
- name: collectionItems
paths:
  /collections/{collectionId}/folders:
    post:
      operationId: createCollectionFolder
      summary: Create a folder
      description: 'Creates a folder in a collection. For a complete list of properties, refer to the **Folder** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).


        You can use this endpoint to to import requests and responses into a newly-created folder. To do this, include the `requests` field and the list of request objects in the request body. For more information, see the provided example.


        **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 folder with a blank name.

        '
      tags:
      - collectionItems
      parameters:
      - name: collectionId
        in: path
        description: The collection's ID.
        required: true
        schema:
          $ref: '#/components/schemas/collectionId'
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createCollectionFolderResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCollectionFolderRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createCollectionFolder'
  /collections/{collectionId}/requests:
    post:
      operationId: createCollectionRequest
      summary: 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.

        '
      tags:
      - collectionItems
      parameters:
      - name: collectionId
        in: path
        description: The collection's ID.
        required: true
        schema:
          $ref: '#/components/schemas/collectionId'
      - name: folderId
        in: query
        description: The folder ID in which to create the request. By default, the system will create the request at the collection level.
        required: false
        schema:
          $ref: '#/components/schemas/collectionFolderId'
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createCollectionRequestResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCollectionRequestRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createCollectionRequest'
  /collections/{collectionId}/responses:
    post:
      operationId: createCollectionResponse
      summary: Create a response
      description: 'Creates a request response in a collection. For a complete list of request body properties, refer to the **Response** 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 response with a blank name.

        '
      tags:
      - collectionItems
      parameters:
      - name: collectionId
        in: path
        description: The collection's ID.
        required: true
        schema:
          $ref: '#/components/schemas/collectionId'
      - name: request
        in: query
        description: The parent request's ID.
        required: true
        schema:
          $ref: '#/components/schemas/collectionRequestId'
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createCollectionResponseResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCollectionResponseRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createCollectionResponse'
  /collections/{collectionId}/folders/{folderId}:
    get:
      operationId: getCollectionFolder
      summary: Get a folder
      description: Gets information about a folder in a collection.
      tags:
      - collectionItems
      parameters:
      - name: folderId
        in: path
        description: The folder's ID.
        required: true
        schema:
          $ref: '#/components/schemas/collectionFolderId'
      - name: collectionId
        in: path
        description: The collection's ID.
        required: true
        schema:
          $ref: '#/components/schemas/collectionId'
      - name: ids
        in: query
        description: If true, returns only properties that contain ID values in the response.
        required: false
        schema:
          $ref: '#/components/schemas/booleanQuery'
      - name: uid
        in: query
        description: If true, returns all IDs in UID format (`userId`-`id`).
        required: false
        schema:
          $ref: '#/components/schemas/booleanQuery'
      - name: populate
        in: query
        description: If true, returns all of the collection item's contents.
        required: false
        schema:
          $ref: '#/components/schemas/booleanQuery'
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getCollectionFolder'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCollectionFolderRequestInternalServerError'
    put:
      operationId: updateCollectionFolder
      summary: Update a folder
      description: 'Updates a folder in a collection. For a complete list of properties, refer to the **Folder** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).


        **Note:**


        This endpoint acts like a PATCH method. It only updates the values that you pass in the request body (for example, the `name` property). The endpoint does not update the entire resource.

        '
      tags:
      - collectionItems
      parameters:
      - name: folderId
        in: path
        description: The folder's ID.
        required: true
        schema:
          $ref: '#/components/schemas/collectionFolderId'
      - name: collectionId
        in: path
        description: The collection's ID.
        required: true
        schema:
          $ref: '#/components/schemas/collectionId'
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/updateCollectionFolderResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateCollectionFolderRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateCollectionFolder'
    delete:
      operationId: deleteCollectionFolder
      summary: Delete a folder
      description: Deletes a folder in a collection.
      tags:
      - collectionItems
      parameters:
      - name: folderId
        in: path
        description: The folder's ID.
        required: true
        schema:
          $ref: '#/components/schemas/collectionFolderId'
      - name: collectionId
        in: path
        description: The collection's ID.
        required: true
        schema:
          $ref: '#/components/schemas/collectionId'
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deleteCollectionFolder'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteCollectionFolderRequestInternalServerError'
  /collections/{collectionId}/requests/{requestId}:
    get:
      operationId: getCollectionRequest
      summary: Get a request
      description: Gets information about a request in a collection.
      tags:
      - collectionItems
      parameters:
      - name: requestId
        in: path
        description: The request's ID.
        required: true
        schema:
          $ref: '#/components/schemas/collectionRequestId'
      - name: collectionId
        in: path
        description: The collection's ID.
        required: true
        schema:
          $ref: '#/components/schemas/collectionId'
      - name: ids
        in: query
        description: If true, returns only properties that contain ID values in the response.
        required: false
        schema:
          $ref: '#/components/schemas/booleanQuery'
      - name: uid
        in: query
        description: If true, returns all IDs in UID format (`userId`-`id`).
        required: false
        schema:
          $ref: '#/components/schemas/booleanQuery'
      - name: populate
        in: query
        description: If true, returns all of the collection item's contents.
        required: false
        schema:
          $ref: '#/components/schemas/booleanQuery'
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getCollectionRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCollectionRequestRequestInternalServerError'
    put:
      operationId: updateCollectionRequest
      summary: 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.

        '
      tags:
      - collectionItems
      parameters:
      - name: requestId
        in: path
        description: The request's ID.
        required: true
        schema:
          $ref: '#/components/schemas/collectionRequestId'
      - name: collectionId
        in: path
        description: The collection's ID.
        required: true
        schema:
          $ref: '#/components/schemas/collectionId'
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/updateCollectionRequestResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateCollectionRequestRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateCollectionRequest'
    delete:
      operationId: deleteCollectionRequest
      summary: Delete a request
      description: Deletes a request in a collection.
      tags:
      - collectionItems
      parameters:
      - name: requestId
        in: path
        description: The request's ID.
        required: true
        schema:
          $ref: '#/components/schemas/collectionRequestId'
      - name: collectionId
        in: path
        description: The collection's ID.
        required: true
        schema:
          $ref: '#/components/schemas/collectionId'
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deleteCollectionRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteCollectionRequestRequestInternalServerError'
  /collections/{collectionId}/responses/{responseId}:
    get:
      operationId: getCollectionResponse
      summary: Get a response
      description: Gets information about a response in a collection.
      tags:
      - collectionItems
      parameters:
      - name: responseId
        in: path
        description: The response's ID.
        required: true
        schema:
          $ref: '#/components/schemas/collectionResponseId'
      - name: collectionId
        in: path
        description: The collection's ID.
        required: true
        schema:
          $ref: '#/components/schemas/collectionId'
      - name: ids
        in: query
        description: If true, returns only properties that contain ID values in the response.
        required: false
        schema:
          $ref: '#/components/schemas/booleanQuery'
      - name: uid
        in: query
        description: If true, returns all IDs in UID format (`userId`-`id`).
        required: false
        schema:
          $ref: '#/components/schemas/booleanQuery'
      - name: populate
        in: query
        description: If true, returns all of the collection item's contents.
        required: false
        schema:
          $ref: '#/components/schemas/booleanQuery'
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getCollectionResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCollectionResponseRequestInternalServerError'
    put:
      operationId: updateCollectionResponse
      summary: Update a response
      description: 'Updates a response in a collection. For a complete list of properties, see 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 UID (`12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2`), in this endpoint.

        - This endpoint acts like a PATCH method. It only updates the values that you pass in the request body (for example, the `name` property). The endpoint does not update the entire resource.

        '
      tags:
      - collectionItems
      parameters:
      - name: responseId
        in: path
        description: The response's ID.
        required: true
        schema:
          $ref: '#/components/schemas/collectionResponseId'
      - name: collectionId
        in: path
        description: The collection's ID.
        required: true
        schema:
          $ref: '#/components/schemas/collectionId'
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/updateCollectionResponseResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateCollectionResponseRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateCollectionResponse'
    delete:
      operationId: deleteCollectionResponse
      summary: Delete a response
      description: Deletes a response in a collection.
      tags:
      - collectionItems
      parameters:
      - name: responseId
        in: path
        description: The response's ID.
        required: true
        schema:
          $ref: '#/components/schemas/collectionResponseId'
      - name: collectionId
        in: path
        description: The collection's ID.
        required: true
        schema:
          $ref: '#/components/schemas/collectionId'
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deleteCollectionResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteCollectionResponseRequestInternalServerError'
components:
  schemas:
    updateCollectionRequest:
      type: object
      properties:
        name:
          type: string
          description: The request's name.
        description:
          type:
          - string
          - 'null'
          description: The request's description.
        method:
          $ref: '#/components/schemas/request-method'
        url:
          type:
          - string
          - 'null'
          description: The request's URL.
        headerData:
          $ref: '#/components/schemas/request-header-data'
        queryParams:
          $ref: '#/components/schemas/request-query-params'
        dataMode:
          $ref: '#/components/schemas/UpdateCollectionRequestDataMode'
          description: The request body's data mode.
        data:
          $ref: '#/components/schemas/request-data'
        rawModeData:
          type:
          - string
          - 'null'
          description: The request body's raw mode data.
        graphqlModeData:
          $ref: '#/components/schemas/request-graphql-mode-data'
        dataOptions:
          $ref: '#/components/schemas/request-data-options'
        auth:
          $ref: '#/components/schemas/request-auth'
        events:
          $ref: '#/components/schemas/request-events'
      description: The request properties to update. For a complete list of properties, refer to the **Request** property in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v1.0.0/draft-07/collection.json).
      title: updateCollectionRequest
    UpdateCollectionResponseRequestInternalServerError:
      oneOf:
      - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
      - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      - $ref: '#/components/schemas/commonErrorNameMessage'
      title: UpdateCollectionResponseRequestInternalServerError
    createCollectionResponse:
      type: object
      properties:
        name:
          type: string
          description: The response's name. 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 response with a blank name.
        description:
          type:
          - string
          - 'null'
          description: The response's description.
        url:
          type:
          - string
          - 'null'
          description: The associated request's URL.
        method:
          $ref: '#/components/schemas/request-method'
        headers:
          $ref: '#/components/schemas/header-list-2'
        dataMode:
          $ref: '#/components/schemas/CreateCollectionResponseDataMode'
          description: The associated request body's data mode.
        rawModeData:
          type:
          - string
          - 'null'
          description: The associated request body's raw mode data.
        dataOptions:
          $ref: '#/components/schemas/request-data-options'
        responseCode:
          $ref: '#/components/schemas/CreateCollectionResponseResponseCode'
          description: The response's HTTP response code information.
        status:
          type:
          - string
          - 'null'
          description: The response's HTTP status text.
        time:
          type: string
          description: The time taken by the request to complete, in milliseconds.
        cookies:
          type:
          - string
          - 'null'
          description: The response's cookie data.
        mime:
          type:
          - string
          - 'null'
          description: The response's MIME type.
        text:
          type: string
          description: The raw text of the response body.
        language:
          type: string
          description: The response body's language type.
        rawDataType:
          type:
          - string
          - 'null'
          description: The response's raw data type.
        requestObject:
          type: string
          description: A JSON-stringified representation of the associated request.
      description: 'Information about the response. For a complete list of properties, refer to the **Response** 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 response with a blank name.

        '
      title: createCollectionResponse
    GetCollectionResponseData:
      type: object
      properties:
        id:
          type: string
          description: The response's ID.
        request:
          type: string
          description: The ID of the request that the response belongs to.
        name:
          type: string
          description: The response's name.
        owner:
          type: string
          description: The user ID of the response's owner.
        createdAt:
          type: string
          format: date-time
          description: The response's creation date and time.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the response was last updated.
        lastRevision:
          type: integer
          format: int64
          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.
        lastUpdatedBy:
          type: string
          description: The user ID of the user that last updated the response.
      description: Information about the response. For a complete list of properties, refer to the **Response** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).
      title: GetCollectionResponseData
    GetCollectionFolderData:
      type: object
      properties:
        id:
          type: string
          description: The folder's ID.
        name:
          type: string
          description: The folder's name.
        description:
          type: string
          description: The folder's description.
        createdAt:
          type: string
          format: date-time
          description: The folder's creation date and time.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the folder was last updated.
        owner:
          type: string
          description: The user ID of the folder's owner.
        lastUpdatedBy:
          type: string
          description: The user ID of the user that last updated the folder.
        lastRevision:
          type: integer
          format: int64
          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.
        collection:
          type: string
          description: The collection ID that the folder belongs to.
      description: Information about the folder. For a complete list of properties, refer to the **Folders** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).
      title: GetCollectionFolderData
    DeleteCollectionFolderRequestInternalServerError:
      oneOf:
      - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
      - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      - $ref: '#/components/schemas/commonErrorNameMessage'
      title: DeleteCollectionFolderRequestInternalServerError
    createCollectionFolder:
      type: object
      properties:
        name:
          type: string
          description: The folder's name. 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

# --- truncated at 32 KB (77 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/openapi/postman-collectionitems-api-openapi.yml