Postman collection
1.0.0Schema URL
Properties
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 this is a different collection than it was originally.
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.
The order array ensures that your requests and folders don't randomly get shuffled up. It holds a sequence of UUIDs corresponding to folders and requests. Note that if a folder ID or a request ID (if the request is not already part of a folder) is not included in the order array, the request or the folder will not show up in the collection.
Provide a long description of this collection using this field. This field supports markdown syntax to better format the description.
The folders order array ensures that your requests and folders don't randomly get shuffled up. It holds a sequence of UUIDs corresponding to folders and requests. Note that if a folder ID or a request ID (if the request is not already part of a folder) is not included in the order array, the request or the folder will not show up in the collection.
Folders are the way to go if you want to group your requests and to keep things organised. Folders can also be useful in sequentially requesting a part of the entire collection by using Postman Collection Runner or Newman on a particular folder.
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.
Set of configurations used to alter the usual behavior of sending the request
Definitions
Represents an attribute for any authorization method provided by Postman. For example username and password are set as auth attributes for Basic Authentication method.
Represents authentication helpers provided by Postman
The attributes for API Key Authentication
The attributes for AWS Auth.
The attributes for Basic Authentication.
The helper attributes for Bearer Token Authentication
The attributes for Digest Authentication.
The attributes for Akamai EdgeGrid Authentication.
The attributes for Hawk Authentication
The attributes for NTLM Authentication
The attributes for OAuth2
Helper attributes for OAuth2
Postman can associate helpers with a request, which help with activities such as OAuth, Basic Authentication, etc. The type of helper associated with this request is stored in this field.
A Description can be a raw text, or be an object, which holds the description along with its format.
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.
Defines a script associated with an associated event name
Can be set to test or prerequest for test scripts or pre-request scripts respectively.
A unique identifier for the enclosing event.
A script is a snippet of Javascript code that can be used to to perform setup or teardown operations on a particular response.
5 nested properties
A unique, user defined identifier that can be used to refer to this script from requests.
Type of the script. E.g: 'text/javascript'
If object, contains the complete broken-down URL for this request. If string, contains the literal request URL.
Script name
Indicates whether the event is disabled. If absent, the event is assumed to be enabled.
One of the primary goals of Postman is to organize the development of APIs. To this end, it is necessary to be able to group requests together. This can be achived using 'Folders'. A folder just is an ordered set of requests.
In order to be able to uniquely identify different folders within a collection, Postman assigns each folder a unique ID (a UUID). This field contains that value.
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.
Essays about the folder go into this field!
Postman preserves the order of your requests within each folder. This field holds a sequence of UUIDs, where each ID corresponds to a particular Postman request.
Postman preserves the order of your folders within each folder. This field holds a sequence of UUIDs, where each ID corresponds to a particular collection folder.
Postman folders are always a part of a collection. That collection's unique ID (which is a UUID) is stored in this field.
Postman folders are always a part of a collection. That collection's unique ID (which is a UUID) is stored in this field.
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.
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.
Set of configurations used to alter the usual behavior of sending the request
A helper may require a number of parameters to actually be helpful. The parameters used by the helper can be stored in this field, as an object. E.g when using Basic Authentication, the username and password will be stored here.
In some use cases, it's necessary to run a bit of code or perform some tasks before sending a request. Postman implements this feature by the use of this field. Any code written to this field is run before running a request.
Set of configurations used to alter the usual behavior of sending the request
A request represents an HTTP request.
Postman requests may or may not be a part of a folder. If this request belongs to a folder, that folder's unique ID (which is a UUID) is stored in this field.
Postman can store a number of requests in each collection. In order to preserve the order of each request, we need to be able to identify requests uniquely. This field is a UUID assigned to each request.
Sometimes, you just need to call your request 'Bob'. Postman will let you do that, and store the name you give in this field.
Additional configurations and options set for various body modes.
When set to true, prevents request body from being sent.
A request can have an associated description text. Since description is meant to be long, it can be in either html or markdown formats. This field specifies that format.
The description of this request. Can be as long as you want. Postman also supports two formats for your description, markdown and html.
No HTTP request is complete without its headers, and the same is true for a Postman request. This field contains all the HTTP Headers in a raw string format.
Postman can associate helpers with a request, which help with activities such as OAuth, Basic Authentication, etc. The type of helper associated with this request is stored in this field.
A helper may require a number of parameters to actually be helpful. The parameters used by the helper can be stored in this field, as an object. E.g when using Basic Authentication, the username and password will be stored here.
A Postman request allows you to use Path Variables in a request, e.g: /search/:bookId. This field stores these variables.
Contains the complete URL for this request, along with the path variables, if any.
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.
In some use cases, it's necessary to run a bit of code or perform some tasks before sending a request. Postman implements this feature by the use of this field. Any code written to this field is run before running a request.
Postman allows you to define a script that is run after executing the request, which may act on the response. Such a script is stored in this field.
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.
The timestamp for this request.
A Postman request can have multiple responses associated with it. These responses are stored in this field.
Contains the raw data (parameters) that Postman sends to the server
This field contains the GraphQL request body
This field contains the unique ID of the collection to which this request belongs.
This field contains the unique ID of the collection to which this request belongs.
Set of configurations used to alter the usual behavior of sending the request
Postman preserves the order of your responses within each request. This field holds a sequence of UUIDs, where each ID corresponds to a particular response.
A script is a snippet of Javascript code that can be used to to perform setup or teardown operations on a particular response.
A unique, user defined identifier that can be used to refer to this script from requests.
Type of the script. E.g: 'text/javascript'
If object, contains the complete broken-down URL for this request. If string, contains the literal request URL.
Script name
Postman allows you to define a script that is run after executing the request, which may act on the response. Such a script is stored in this field.
If object, contains the complete broken-down URL for this request. If string, contains the literal request URL.
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.
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.
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.
A variable key is a human friendly value that identifies the variable within a collection. In traditional terms, this would be a variable name.
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
A variable may have multiple types. This field specifies the type of the variable.
Variable name
A Description can be a raw text, or be an object, which holds the description along with its format.
When set to true, indicates that this variable has been set by Postman