Collection Information

APIs.ioEngineeringPlatform

Properties

Name Type Description
collection object For a complete list of this endpoint's possible values, use the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-getcollection-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/getCollection",
  "title": "Collection Information",
  "type": "object",
  "properties": {
    "collection": {
      "type": "object",
      "additionalProperties": true,
      "description": "For a complete list of this endpoint's possible values, use the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).",
      "properties": {
        "info": {
          "type": "object",
          "description": "An object that contains basic information about the collection.",
          "properties": {
            "_postman_id": {
              "type": "string",
              "description": "The collection's Postman ID.",
              "example": "12ece9e1-2abf-4edc-8e34-de66e74114d2"
            },
            "name": {
              "type": "string",
              "description": "The collection's name.",
              "example": "Test Collection"
            },
            "description": {
              "type": "string",
              "description": "The collection's description.",
              "example": "This is a sample collection that makes a tiny request to Postman Echo service to get the list of request headers sent by a HTTP client."
            },
            "schema": {
              "type": "string",
              "format": "url",
              "description": "A URL to the collection's schema.",
              "example": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
            },
            "fork": {
              "type": "object",
              "description": "If the collection was forked from another collection, this object contains information about the fork.",
              "properties": {
                "label": {
                  "type": "string",
                  "description": "The fork's label.",
                  "example": "Collection fork"
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "description": "The date and time at which the collection was forked.",
                  "example": "2024-07-17T13:12:43.000Z"
                },
                "from": {
                  "type": "string",
                  "format": "uid",
                  "description": "The source (parent) collection's unique ID.",
                  "example": "87654321-c8142d52-f97d-46a7-bc77-52bb99713o1n"
                }
              }
            },
            "updatedAt": {
              "type": "string",
              "format": "date-time",
              "description": "The date and time at which the collection was last updated.",
              "example": "2023-10-13T08:14:22.000Z"
            },
            "uid": {
              "type": "string",
              "format": "uid",
              "description": "The collection's unique ID.",
              "example": "12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2"
            },
            "createdAt": {
              "type": "string",
              "format": "date-time",
              "description": "The date and time at which the collection was created.",
              "example": "2023-10-08T13:04:28.000Z"
            },
            "lastUpdatedBy": {
              "type": "string",
              "description": "The user ID of the user who last updated the collection.",
              "example": "12345678"
            }
          }
        },
        "item": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true,
            "description": "The collection's request information. For a complete list of values, 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). If you pass an empty object for this value, the system defaults to an untitled GET request."
          }
        }
      }
    }
  }
}