Postman collectionItems API

openapi: 3.1.0
info:
  title: Postman Collection Items API
  version: 1.0.0
  description: 'Operations tagged collectionItems across 2 of this provider''s published API definitions: postman-api-openapi.yml, postman-collectionitems-api-openapi.yml. Each path carries the servers of the definition it was published in.'
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'
    servers:
    - url: https://api.postman.com
      description: https://api.postman.com
    - url: https://api.eu.postman.com
      description: https://api.eu.postman.com
  /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'
    servers:
    - url: https://api.postman.com
      description: https://api.postman.com
    - url: https://api.eu.postman.com
      description: https://api.eu.postman.com
  /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'
    servers:
    - url: https://api.postman.com
      description: https://api.postman.com
    - url: https://api.eu.postman.com
      description: https://api.eu.postman.com
  /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'
    servers:
    - url: https://api.postman.com
      description: https://api.postman.com
    - url: https://api.eu.postman.com
      description: https://api.eu.postman.com
  /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'
    servers:
    - url: https://api.postman.com
      description: https://api.postman.com
    - url: https://api.eu.postman.com
      description: https://api.eu.postman.com
  /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'
    servers:
    - url: https://api.postman.com
      description: https://api.postman.com
    - url: https://api.eu.postman.com
      description: https://api.eu.postman.com
components:
  schemas:
    collectionResponseId:
      type: string
      title: collectionResponseId
    updateCollectionResponseResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/UpdateCollectionResponseResponseData'
          description: Information about the updated response. For a complete list of response 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).
        meta:
          type: object
          additionalProperties:
            description: Any type
          description: A Postman-specific response that contains information about the internal performed operation.
        model_id:
          type: string
          description: The response's ID.
      title: updateCollectionResponseResponse
    commonErrorNameMessageDetails:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/CommonErrorNameMessageDetailsError'
      title: commonErrorNameMessageDetails
    CommonErrorTypeTitleDetailStatusType:
      oneOf:
      - type: string
        format: uri-reference
      - type: string
      title: CommonErrorTypeTitleDetailStatusType
    CreateCollectionResponseDataMode:
      type: string
      enum:
      - raw
      - urlencoded
      - formdata
      - binary
      - graphql
      description: The associated request body's data mode.
      title: CreateCollectionResponseDataMode
    updateCollectionFolderResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/UpdateCollectionFolderResponseData'
          description: The folder's updated information, including the updated properties. For a complete list of properties, refer to the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v1.0.0/draft-07/collection.json).
        meta:
          type: object
          additionalProperties:
            description: Any type
          description: A Postman-specific response that contains information about the internal performed operation.
        model_id:
          type: string
          description: The folder's ID.
        revision:
          type: number
          format: double
          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.
      title: updateCollectionFolderResponse
    commonErrorTypeTitleDetail:
      type: object
      properties:
        type:
          type: string
          description: The type of error.
        title:
          type: string
          description: A short summary of the problem.
        detail:
          $ref: '#/components/schemas/CommonErrorTypeTitleDetailDetail'
          description: Information about the error.
      title: commonErrorTypeTitleDetail
    RequestDataOptionsParams:
      type: object
      properties: {}
      description: Options for the `params` data mode.
      title: RequestDataOptionsParams
    RequestAuthType:
      type: string
      enum:
      - basic
      - bearer
      - apikey
      - digest
      - oauth1
      - oauth2
      - hawk
      - awsv4
      - ntlm
      - edgegrid
      - jwt
      - asap
      - noauth
      description: The authorization type.
      title: RequestAuthType
    UpdateCollectionResponseDataMode:
      type: string
      enum:
      - raw
      - urlencoded
      - formdata
      - binary
      - graphql
      description: The associated request body's data mode.
      title: UpdateCollectionResponseDataMode
    booleanQuery:
      type: boolean
      title: booleanQuery
    RequestDataItemsType:
      type: string
      enum:
      - text
      - file
      description: The form data's type.
      title: RequestDataItemsType
    CreateCollectionRequestDataMode:
      type: string
      enum:
      - raw
      - urlencoded
      - formdata
      - binary
      - graphql
      description: The request body's data mode.
      title: CreateCollectionRequestDataMode
    updateCollectionRequestResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/UpdateCollectionRequestResponseData'
          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).
        meta:
          type: object
          additionalProperties:
            description: Any type
          description: A Postman-specific response that contains information about the internal performed operation.
        model_id:
          type: string
          description: The request's ID.
        revision:
          type: number
          format: double
          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.
      title: updateCollectionRequestResponse
    RequestDataOptionsBinary:
      type: object
      properties: {}
      description: Options for the `binary` data mode.
      title: RequestDataOptionsBinary
    RequestEventsItemsListen:
      type: string
      enum:
      - test
      - prerequest
      description: The event type.
      title: RequestEventsItemsListen
    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 

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