Postman Import API
The import API from Postman — 1 operation(s) for import.
Operations 1
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
The import API from Postman — 1 operation(s) for import.
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/postman:postman-import-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Postman Import 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: Import
paths:
/import/openapi:
post:
operationId: openApiDefinition
summary: Import an OpenAPI definition
description: 'Imports an OpenAPI definition into Postman as a new Postman Collection.
**Note:**
- This endpoint has a rate limit of **10 requests per 10 seconds**.
- The Postman web app does not support the `file` input method type.
- If you do not include the `workspace` query parameter, the system imports the definition into the oldest personal Internal workspace you own.
- For an example of importing a file, see the Postman API collection.'
tags:
- Import
parameters:
- name: workspace
in: query
description: The workspace's ID.
required: true
schema:
$ref: '#/components/schemas/workspaceId'
- name: x-api-key
in: header
required: true
schema:
type: string
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/importOpenApiDefinition'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/import400Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ImportOpenApiDefinitionRequestUnauthorizedError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ImportOpenApiDefinitionRequestInternalServerError'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Import_openApiDefinition_Request'
components:
schemas:
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
commonErrorNameMessage:
type: object
properties:
error:
$ref: '#/components/schemas/CommonErrorNameMessageError'
description: Information about the error.
title: commonErrorNameMessage
commonErrorNameMessageDetails:
type: object
properties:
error:
$ref: '#/components/schemas/CommonErrorNameMessageDetailsError'
title: commonErrorNameMessageDetails
jsonStringified:
type: object
properties:
type:
$ref: '#/components/schemas/JsonStringifiedType'
description: The `string` type value.
input:
type: string
description: The stringified OpenAPI definition.
options:
$ref: '#/components/schemas/generateCollectionOptions'
required:
- type
- input
title: jsonStringified
JsonSchemaInput:
type: object
properties: {}
description: An object that contains a valid JSON OpenAPI definition. For more information, read the [OpenAPI documentation](https://swagger.io/docs/specification/basic-structure/).
title: JsonSchemaInput
GenerateCollectionOptionsFolderStrategy:
type: string
enum:
- Paths
- Tags
default: Paths
description: Whether to create folders based on the specification's `paths` or `tags` properties.
title: GenerateCollectionOptionsFolderStrategy
jsonSchema:
type: object
properties:
type:
$ref: '#/components/schemas/JsonSchemaType'
description: The `json` type value.
input:
$ref: '#/components/schemas/JsonSchemaInput'
description: An object that contains a valid JSON OpenAPI definition. For more information, read the [OpenAPI documentation](https://swagger.io/docs/specification/basic-structure/).
options:
$ref: '#/components/schemas/generateCollectionOptions'
required:
- type
- input
title: jsonSchema
importOpenApiDefinition:
type: object
properties:
collections:
type: array
items:
$ref: '#/components/schemas/ImportOpenApiDefinitionCollectionsItems'
title: importOpenApiDefinition
ImportOpenApiDefinitionCollectionsItems:
type: object
properties:
id:
type: string
description: The collection's ID.
name:
type: string
description: The collection's name.
uid:
type: string
format: uid
description: The collection's unique ID.
title: ImportOpenApiDefinitionCollectionsItems
GenerateCollectionOptionsIndentCharacter:
type: string
enum:
- Tab
- Space
default: Space
description: The option for setting the indentation character type.
title: GenerateCollectionOptionsIndentCharacter
ImportOpenApiDefinitionRequestUnauthorizedError:
oneOf:
- $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
- $ref: '#/components/schemas/commonErrorNameMessage'
title: ImportOpenApiDefinitionRequestUnauthorizedError
CommonErrorTypeTitleDetailStatusType:
oneOf:
- type: string
format: uri-reference
- type: string
title: CommonErrorTypeTitleDetailStatusType
ImportOpenApiDefinitionRequestInternalServerError:
oneOf:
- $ref: '#/components/schemas/commonErrorTypeTitleDetail'
- $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
- $ref: '#/components/schemas/commonErrorNameMessage'
title: ImportOpenApiDefinitionRequestInternalServerError
commonErrorTypeTitleDetailStatus:
type: object
properties:
type:
$ref: '#/components/schemas/CommonErrorTypeTitleDetailStatusType'
title:
type: string
description: A short summary of the problem.
detail:
type: string
description: Information about the error.
status:
type: integer
description: The error's HTTP status code.
title: commonErrorTypeTitleDetailStatus
JsonStringifiedType:
type: string
enum:
- string
description: The `string` type value.
title: JsonStringifiedType
import400Error:
oneOf:
- $ref: '#/components/schemas/commonErrorNameMessage'
- $ref: '#/components/schemas/commonErrorNameMessageDetails'
title: import400Error
CommonErrorNameMessageDetailsErrorDetails:
oneOf:
- type: object
additionalProperties:
description: Any type
- type: array
items:
type: string
description: Information about the error.
title: CommonErrorNameMessageDetailsErrorDetails
GenerateCollectionOptionsRequestNameSource:
type: string
enum:
- Fallback
- URL
default: Fallback
description: 'Determines how the generated collection''s requests are named. If the `Fallback` value is passed, then the request is named after one of the following values in the schema:
- `summary`
- `operationId`
- `description`
- `url`
'
title: GenerateCollectionOptionsRequestNameSource
Import_openApiDefinition_Request:
oneOf:
- $ref: '#/components/schemas/jsonSchema'
- $ref: '#/components/schemas/jsonStringified'
title: Import_openApiDefinition_Request
CommonErrorTypeTitleDetailDetail:
oneOf:
- type: string
- type: object
additionalProperties:
description: Any type
description: Information about the error.
title: CommonErrorTypeTitleDetailDetail
generateCollectionOptions:
type: object
properties:
requestNameSource:
$ref: '#/components/schemas/GenerateCollectionOptionsRequestNameSource'
default: Fallback
description: 'Determines how the generated collection''s requests are named. If the `Fallback` value is passed, then the request is named after one of the following values in the schema:
- `summary`
- `operationId`
- `description`
- `url`
'
indentCharacter:
$ref: '#/components/schemas/GenerateCollectionOptionsIndentCharacter'
default: Space
description: The option for setting the indentation character type.
parametersResolution:
type: string
default: Schema
description: Generated collections use examples for parameter generation by default. Any existing collections generated using the schema parameter generation will continue to sync using their existing strategy.
folderStrategy:
$ref: '#/components/schemas/GenerateCollectionOptionsFolderStrategy'
default: Paths
description: Whether to create folders based on the specification's `paths` or `tags` properties.
includeAuthInfoInExample:
type: boolean
default: true
description: If true, include the authentication parameters in the example request.
enableOptionalParameters:
type: boolean
default: true
description: If true, enables optional parameters in the collection and its requests.
keepImplicitHeaders:
type: boolean
default: false
description: If true, keep the implicit headers from the OpenAPI specification, which are removed by default.
includeDeprecated:
type: boolean
default: true
description: If true, includes all deprecated operations, parameters, and properties in generated collection.
alwaysInheritAuthentication:
type: boolean
default: false
description: Whether authentication details should be included in all requests, or always inherited from the collection.
nestedFolderHierarchy:
type: boolean
default: false
description: If true, creates subfolders in the generated collection based on the order of the endpoints' tags.
description: The advanced creation options and their values. For more details, see Postman's [OpenAPI to Postman Collection Converter OPTIONS documentation](https://github.com/postmanlabs/openapi-to-postman/blob/develop/OPTIONS.md). These properties are case-sensitive.
title: generateCollectionOptions
CommonErrorNameMessageDetailsError:
type: object
properties:
name:
type: string
description: The error name.
message:
type: string
description: The error message.
details:
$ref: '#/components/schemas/CommonErrorNameMessageDetailsErrorDetails'
description: Information about the error.
title: CommonErrorNameMessageDetailsError
CommonErrorNameMessageError:
type: object
properties:
name:
type: string
description: The error name.
message:
type: string
description: The error message.
description: Information about the error.
title: CommonErrorNameMessageError
JsonSchemaType:
type: string
enum:
- json
description: The `json` type value.
title: JsonSchemaType
workspaceId:
type: string
title: workspaceId
securitySchemes:
PostmanApiKey:
type: apiKey
in: header
name: x-api-key
basicAuth:
type: http
scheme: basic
scimApiKey:
type: apiKey
in: header
name: Authorization
description: A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.
x-provenance:
first_party: true
method: harvested
provider_published: true
source: https://learning.postman.com/api-docs/openapi.json
harvested: '2026-08-05'
note: Postman's own OpenAPI 3.1 definition for the Postman API, served by its Fern-hosted API reference. 162 paths, 256 operations, servers api.postman.com and api.eu.postman.com.