Specification of Postman Collection Format v2.1 using the ApiBuilder schema. Further information about Postman Collection Format v2.1 can be found at https://schema.getpostman.com/json/collection/v2.1.0/docs/index.html
Base URL: https://www.getpostman.com
auth
| Field | Type |
|---|---|
| type required | auth_enum |
| basic | [basic_auth] |
basic_auth
| Field | Type |
|---|---|
| key required | string |
| value required | string |
| type | string |
body
| Field | Type |
|---|---|
| raw | string |
| mode | body_mode |
| urlencoded | [url_encoded] |
| file | file |
| formdata | [form_parameter] |
collection
| Field | Type | Description |
|---|---|---|
| info required | info | Detailed description of the info block |
| item required | [items] | Items are the basic unit for a Postman collection. You can think of them as corresponding to a single API endpoint. Each Item has one request and may have multiple API responses associated with it. |
| event required | [event] | Postman allows you to configure scripts to run when specific events occur. These scripts are stored here, and can be referenced in the collection by their ID. |
| variable required | [variable] | Collection variables allow you to define a set of variables, that are a part of the collection, as opposed to environments, which are separate entities.Note: Collection variables must not contain any sensitive information. |
| auth | auth | Represents authentication helpers provided by Postman |
description
| Field | Type | Description |
|---|---|---|
| content | string | The content of the description goes here, as a raw string. |
| type | string | Holds the mime type of the raw description content. E.g: 'text/markdown' or 'text/html'. The type is used to correctly render the description when generating documentation, or in the Postman app. |
event
| Field | Type | Description |
|---|---|---|
| listen required | event_type | Can be set to test or prerequest for test scripts or pre-request scripts respectively. |
| script | script | |
| id | string | A unique identifier for the enclosing event. |
| disabled | boolean | Indicates whether the event is disabled. If absent, the event is assumed to be enabled |
file
| Field | Type |
|---|---|
| src | string |
| content | string |
folder
| Field | Type | Description |
|---|---|---|
| name required | string | A folder's friendly name is defined by this field. You would want to set this field to a value that would allow you to easily identify this folder. |
| description | description | |
| variable | [variable] | |
| item required | [item] | |
| event | [event] | |
| auth | auth |
form_parameter
| Field | Type |
|---|---|
| key required | string |
| value | string |
| disabled | boolean |
| description | description |
| contentType | string |
| type | string |
header
| Field | Type |
|---|---|
| key required | string |
| value required | string |
| disabled | boolean |
| description | description |
info
| Field | Type | Description |
|---|---|---|
| name required | string | A collection's friendly name is defined by this field. You would want to set this field to a value that would allow you to easily identify this collection among a bunch of other collections, as such outlining its usage or content. |
| postman_id | string | Every collection is identified by the unique value of this field. The value of this field is usually easiest to generate using a UID generator function. If you already have a collection, it is recommended that you maintain the same id since changing the id usually implies that is a different collection than it was originally.Note: This field exists for compatibility reasons with Collection Format V1. |
| description | description | A Description can be a raw text, or be an object, which holds the description along with its format. |
| version | string | Postman allows you to version your collections as they grow, and this field holds the version number. While optional, it is recommended that you use this field to its fullest extent! |
| schema required | string | This should ideally hold a link to the Postman schema that is used to validate this collection. E.g: https://schema.getpostman.com/collection/v1 |
item
| Field | Type | Description |
|---|---|---|
| id | string | A unique ID that is used to identify collections internally |
| name | string | A human readable identifier for the current item. |
| description | description | A Description can be a raw text, or be an object, which holds the description along with its format. |
| variable | [variable] | Collection variables allow you to define a set of variables, that are a part of the collection, as opposed to environments, which are separate entities. |
| event | [event] | Postman allows you to configure scripts to run when specific events occur. These scripts are stored here, and can be referenced in the collection by their ID. |
| request required | request | |
| response | [response] |
query_param
| Field | Type |
|---|---|
| key | string |
| value | string |
| disabled | boolean |
| description | description |
request
response
script
| Field | Type | Description |
|---|---|---|
| exec required | [string] | Body of the script in lines |
| type required | string | default: text/javascript Type of the script. E.g: 'text/javascript' |
| id | string | A unique, user defined identifier that can be used to refer to this script from requests. |
| src | string | If object, contains the complete broken-down URL for this request. If string, contains the literal request URL. |
| name | string | Script name |
url
| Field | Type | Description |
|---|---|---|
| raw | string | The string representation of the request URL, including the protocol, host, path, hash, query parameter(s) and path variable(s). |
| protocol | string | The protocol_ associated with the request, E.g: 'http' |
| host | [string] | The host for the URL, E.g: api.yourdomain.com. Can be stored as a string or as an array of strings. |
| path | [string] | |
| port | string | The port number present in this URL. An empty value implies 80/443 depending on whether the protocol_ field contains http/https. |
| query | [query_param] | |
| hash | string | Contains the URL fragment (if any). Usually this is not transmitted over the network, but it could be useful to store this in some cases. |
| variable | [variable] | Postman supports path variables with the syntax /path/:variableName/to/somewhere. These variables are stored in this field. |
url_encoded
| Field | Type |
|---|---|
| key required | string |
| value | string |
| disabled | boolean |
| description | description |
variable
Using variables in your Postman requests eliminates the need to duplicate requests, which can save a lot of time. Variables can be defined, and referenced to from any part of a request.
| Field | Type | Description |
|---|---|---|
| id | string | A variable ID is a unique user-defined value that identifies the variable within a collection. In traditional terms, this would be a variable name. |
| key | string | A variable key is a human friendly value that identifies the variable within a collection. In traditional terms, this would be a variable name. |
| value | string | The value that a variable holds in this collection. Ultimately, the variables will be replaced by this value, when say running a set of requests from a collection |
| type | string | A variable may have multiple types. This field specifies the type of the variable. |
| name | string | Variable name |
| description | description | |
| system | boolean | When set to true, indicates that this variable has been set by Postman |
| disabled | boolean |