PostmanApi TypeScript SDK 1.44.1

Welcome to the PostmanApi SDK documentation. This guide will help you get started with integrating and using the PostmanApi SDK in your project.

Versions

SDK version: 1.44.1

About the API

The Postman API enables you to programmatically access data stored in your Postman account.

For a comprehensive set of examples of requests and responses, see the Postman API collection.

Note:

Certain endpoints may be unavailable depending on your region and/or Postman plan.

Getting started

You can get started with the Postman API by creating a copy of this definition in your workspace.

EU users

For users in the EU with Enterprise plans, the Postman API uses the http://api.eu.postman.com subdomain. This is available in the definition's list of servers. You can change this by selecting the http://api.eu.postman.com subdomain in the Server dropdown list below.

About the Postman API

You must use a valid API Key to send requests to the API endpoints.
The API has rate and usage limits.
The API only responds to HTTPS-secured communications. Any requests sent via HTTP return an HTTP 301 redirect to the corresponding HTTPS resources.
The API returns requests responses in JSON format.
The request method (verb) determines the nature of action you intend to perform. A request made using the GET method implies that you want to fetch something from Postman. The POST method implies you want to save something new to Postman.
For all requests, API calls respond with their corresponding HTTP status codes. In the Postman client, the status code also provides help text that details the possible meaning of the response code.

IDs and UIDs

All items in Postman, such as collections, workspaces, and APIs, have IDs and UIDs:

An ID is the unique ID assigned to a Postman item. For example, ec29121c-5203-409f-9e84-e83ffc10f226.
The UID is the full ID of a Postman item. This value is the item's unique ID concatenated with the user ID. For example, in the 12345678-ec29121c-5203-409f-9e84-e83ffc10f226 UID, where 12345678 is the user's ID and ec29121c-5203-409f-9e84-e83ffc10f226 is the item's ID.

Enum values

Any documented enum values should be considered partial lists and may change over time.

403 response for unavailable features

Depending on your region and/or Postman plan, some endpoints will return an HTTP 403 Forbidden response with the "This feature isn't available in your region." detail.

503 response

An HTTP 503 Service Unavailable response from our servers indicates there is an unexpected spike in API access traffic. The server is usually operational within the next five minutes.

If the outage persists or you receive any other form of an HTTP 5XX error, contact support.

Authentication

Postman uses API keys for authentication. The API key tells the API server that the request came from you. Everything that you have access to in Postman is accessible with your API key. You can generate a Postman API key in the API keys section of your Postman account settings.

You must include an API key in each request to the Postman API with the X-API-Key request header. In Postman, you can store your API key as a vault secret or an environment variable. The Postman API collection will use it to make API calls.

SCIM authentication

While all other endpoints in this collection require a Postman API key, the SCIM endpoints require a SCIM API key.

Authentication error response

If an API key is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.

Rate and usage limits

API access rate limits apply at a per-user basis in unit time. The limit is 300 requests per minute.

Postman Monitors, as well as the GET /collections, GET /workspaces, and GET /workspaces/{id} endpoints have a rate limit of 10 calls in 10 seconds.
Workspace updates endpoints have a rate limit of 20 requests per minute per user.
The POST /service-account-tokens endpoint has a rate limit of 10 requests per 10 second window per user.

Depending on your plan, you may also have usage limits. Every API response includes headers to help you identify the status of your use limits. For more information, see Track Postman API call limits.

When you reach your rate or usage limits, the API returns the following HTTP 429 Too Many Requests status code with one of the following error responses:

rateLimited — Rate limits reached. The response returns the time after which you can resume calls to the Postman API. The response header also includes the X-RateLimit-RetryAfter and Retry-After responses when you go over your limit, which returns the seconds remaining until you can make another request.
serviceLimitExhausted — Postman API service limits reached. You will need to contact your Postman Team Admin for assistance.

Support

For help regarding accessing the Postman API, you can:

Visit Postman Support or our Community and Support sites.
Reach out to the Postman community.
Submit a help request to Postman support.

Policies

Setup & Configuration

Supported Language Versions

This SDK is compatible with the following versions: TypeScript >= 4.8.4

Installation

To get started with the SDK, we recommend installing using npm or yarn:

npm install @postman/api-sdk

or

yarn add @postman/api-sdk

Authentication

Basic Authentication

The PostmanApi API uses Basic Authentication.

You need to provide your username and password when initializing the SDK.

Setting the Username and Password

When you initialize the SDK, you can set the username and password as follows:

const sdk = new PostmanApi({ username: 'YOUR_USERNAME', password: 'YOUR_PASSWORD' });

If you need to set or update the username and password after initializing the SDK, you can use:

const sdk = new PostmanApi();
sdk.username = 'YOUR_USERNAME';
sdk.password = 'YOUR_PASSWORD';

API Key Authentication

The PostmanApi API uses API keys as a form of authentication. An API key is a unique identifier used to authenticate a user, developer, or a program that is calling the API.

Setting the API key

When you initialize the SDK, you can set the API key as follows:

const sdk = new PostmanApi({ apiKey: 'YOUR_API_KEY' });

If you need to set or update the API key after initializing the SDK, you can use:

const sdk = new PostmanApi();
sdk.apiKey = 'YOUR_API_KEY';

Setting a Custom Timeout

You can set a custom timeout for the SDK's HTTP requests as follows:

const postmanApi = new PostmanApi({ timeout: 10000 });

Sample Usage

Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:

import { PostmanApi } from '@postman/api-sdk';

(async () => {
  const postmanApi = new PostmanApi({
    apiKey: 'YOUR_API_KEY',
  });

  const data = await postmanApi.billing.getAccounts();

  console.log(data);
})();

Services

The SDK provides various services to interact with the API.

Below is a list of all available services with links to their detailed documentation:

Name
BillingService
AnalyticsService
ApiCatalogService
ApiService
SpecsService
TagsService
AuditLogsService
CollectionAccessKeysService
CollectionsService
CollectionItemsService
CollectionFoldersService
CollectionRequestsService
CollectionResponsesService
CommentsService
ComponentsService
SecretScannerService
EnvironmentsService
GroupsService
Import_Service
WorkspacesService
UsersService
MocksService
MonitorsService
PrivateApiNetworkService
OAuth2_0Service
PostbotService
PullRequestsService
ApiSecurityService
ScimService
SdksService
SearchService
ServiceAccountsService
TeamsService
WebhooksService

Models

The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.

Below is a list of all available models with links to their detailed documentation:

Name	Description
AccountInformation	Information about the account.
InvoicesSlots	Information about the team's slots.
ErrorTypeTitleDetailStatus
GetAuditLogEventActionsClientErrorResponse
CreateApiClientErrorResponse
GetAccountInvoices
AccountInvoice	Information about the invoice.
InvoicesTotal	Information about the invoice's total billed amount.
InvoicesLinks	A JSON API spec object containing hypermedia links.
BillingAccountStatus
GetAnalyticsData
AnalyticsDataSummary
AnalyticsDataObject	Data analytics information.
GetAnalyticsDataSchema
GetAnalyticsDataColumnsData
PaginationData	Information about the response pagination.
AnalyticsDataPartnerEngagementFunnel
PartnersEngagementPartnersData	Information about partner users and their activity.
PartnersEngagementWorkspaceVisits	Information about partner users' workspace visits.
PartnersEngagementCollectionViews	Information about partner users' views of collections in a workspace.
PartnersEngagementRequestsSent	Information about requests sent by partner users.
PartnersEngagementSuccessfulRequestsSent	Information about partner users' successful request calls in a workspace.
AnalyticsResource
AnalyticsMetrics
AnalyticsView
AnalyticsDuration
AnalyticsUserType
AnalyticsEntityType
ErrorTypeTitleDetailStatus
ErrorTypeTitleDetailStatusInstance
GetAnalyticsMetadata
AnalyticsMetadataResourceData	Information about the resource.
AnalyticsMetadataMetricsData	Information about the resource's metric.
AnalyticsMetadataWithParametersAndResponseData	Detailed information about the resource including its metrics, parameters, and response schema.
GetAnalyticsMetadataResourceMetricsDataDetailed	Information about the resource's metric.
GetAnalyticsMetadataResourceMetricsDataDetailedParameters	Information about the metric's parameters.
GetAnalyticsMetadataResourceMetricsDataDetailedParametersView	Information about the `view` parameter.
GetAnalyticsMetadataResourceMetricsDataDetailedParametersFiltersData	Information about the filter.
GetAnalticsMetadataPaginationData	Information about the metric's pagination parameters.
GetAnalyticsMetadataResourceMetricsDataDetailedResponse1	Information about the metric's `response` parameters.
GetAnalyticsMetadataResourceMetricsDataDetailedData	Information about the metric's `detailed` parameter.
GetAnalyticsMetadataResourceMetricsDataSummaryData	Information about the metric's `summary` parameter.
GetApiCatalogDiscoveryServices
GetApiCatalogDiscoveryMetaData	The response's meta information for paginated results.
GetApiCatalogServiceData1	Information about the discovered service.
DiscoveryServicesSource
ErrorTypeStatusTitleDetailErrors
ApiCatalogErrorPathMessage	Information about the error.
ErrorTypeTitleDetailStatus
PostApiCatalogDiscoveryServicesResponse
PostApiCatalogDiscoveryServicesServiceData	Information about a discovered service.
PostApiCatalogDiscoveryServicesResponseMetaData	The operation's metadata summary.
PostApiCatalogDiscoveryServices
PostApiCatalogDiscoveryServiceData	Information about the discovered service.
PostApiCatalogDiscoveryServicesApiDefinitionData	The API definition (specification) for the service. If you pass this with the `endpoints` array, this object is given preference and `endpoints` is ignored.
ApiCatalogDiscoveryServiceEndpointsData	Information about a service's endpoint.
PostApiCatalogDiscoveryServicesProviderMetadataData	Additional metadata from the discovery source provider.
GetApiCatalogDiscoveryService	Information about the discovered service.
ApiCatalogDiscoveryServicesProviderMetadata	Additional metadata from the discovery source provider.
GetApiCatalogDiscoveryServiceApiDefinitionData	The API definition associated with the service.
GetApiCatalogServices
ApiCatalogServiceMetadataTimeRangeData	The time window for the returned data.
ApiCatalogServiceServiceData	Information about the service.
GetApiCatalogService
GetApiCatalogServiceTrafficData	Information about traffic and performance within the time window. If there's no traffic data, this returns a null value.
GetApiCatalogServiceComplianceData	Information about compliance and governance.
GetApiCatalogServiceEntityCountData	Information about the workspace's entities.
GetApiCatalogServiceOwnerData	The service's owner. If no owner is assigned, this returns a null value.
GetApiCatalogServiceEndpoints
GetApiCatalogServiceMonitorRuns
ApiCatalogServiceCollectionData	Information about the collection.
ApiCatalogServiceEnvironmentData	Information about the environment.
ApiCatalogServicePerformanceData	Information about the response time range across all requests in the run.
ApiCatalogServiceStatusFilter
GetApiCatalogServiceSpecificationLints
ApiCatalogServiceSpecLintSeverityFilter
GetApiCatalogServiceCiRuns
GetApiCatalogSystemEnvironments
ApiCatalogSystemEnvironmentsMetaData	The response's meta information for paginated results.
ApiCatalogSystemEnvironmentsFiltersData	The applied filters, if any.
ApiCatalogSystemEnvironmentData	Information about the system environment.
CreateApiCatalogSystemEnvironmentResponse
PostPatchApiCatalogSystemEnvironmentData	Information about the system environment.
CreateApiCatalogSystemEnvironment
GetApiCatalogSystemEnvironment
UpdateApiCatalogSystemEnvironmentResponse
UpdateApiCatalogSystemEnvironment
GetApiCatalogSystemEnvironmentAssociations
GetApiCatalogSystemEnvironmentAssociationsData	Information about the workspace-environment association.
AddApiCatalogSystemEnvironmentAssociationsResponse
AddApiCatalogSystemEnvironmentAssociationsMetaData	The response's meta information for paginated results.
AddApiCatalogSystemEnvironmentAssociationsData	Information about the associated workspace environment.
AddApiCatalogSystemEnvironmentAssociations
RemoveApiCatalogSystemEnvironmentAssociationsResponse
RemoveApiCatalogSystemEnvironmentAssociationsMetaData	The response's meta information for paginated results.
RemoveApiCatalogSystemEnvironmentAssociationsData	Information about the associated workspace environment.
RemoveApiCatalogSystemEnvironmentAssociations
GetApIs	Information about the API schema.
ErrorTypeTitleDetailStatus
GetAuditLogEventActionsClientErrorResponse
CreateApiClientErrorResponse
Api404Error2
ApiCreated
CreateUpdateApi	Information about the API.
ErrorTypeTitleDetailStatusInstance
ErrorTypeTitleMessageDetail
ApiInclude
ApiErrorNameMessage
UpdateApiResponse
ApiCollectionAdded
CopyCollectionToApi
CreateApiCollection
GenerateFromSchema
GetApiCollection
CommentResponseObject
CommentData	Information about the comment.
CommentUpdatedCreatedObject
CommentCreate	Information about the comment.
TaggedUsers	Information about users tagged in the `body` comment.
CommentUpdate	Information about the comment.
SyncCollectionWithSchemaResponse
CreateApiSchemaResponse	Information about the API schema.
CreateApiSchema	Information about the API schema.
ApiSchemaFiles
SchemaFileContents
CreateUpdateApiSchemaFileResponse	Information about the schema file.
CreateUpdateApiSchemaFile	Information about schema file.
GetStatusOfAnAsyncApiTaskOkResponse
GetApiVersions
ApiVersionCreated
CreateVersionSchemaNotGitLinked	Information about the API version.
CreateVersionSchemaGitLinked	Information about the API version.
CreateVersionSchemaGitLinkedWithRootFile	Information about the API version.
ApiVersion
ApiVersionUpdated	Information about the API version.
UpdateApiVersion	Information about the API version.
GetMigrationStatus
GetMigrationStatus400Error
ErrorTypeTitleDetailStatusInstance
ErrorTypeTitleDetailStatus
MigrateToSpecHubResponse
MigrateToExistingWorkspace
MigrateToNewWorkspace
MigrateGitConnectedMonoRepoToNewWorkspace
ErrorTitleMessage
ErrorTitleDetailsMessage
ErrorTypeNameMessageTitle
GetGeneratedCollectionSpecs
CollectionSpecInformation	Information about the collection's API specification.
GetGeneratedCollectionSpecsMeta	The response's meta information for paginated results.
ElementTypeSpec
TaskCreated
GenerateSpecFromCollection
GetAsyncCollectionTaskStatus1
Details	Information about the task's resources.
AsyncTaskFailed
ElementType
GetAllSpecs
SpecType	The type of API specification.
CreateSpecResponse
CreateSpec
CreateApiClientErrorResponse
SpecInformation	Information about the API specification.
FileFormat	The specification's file format.
UpdateSpecPropertiesResponse
UpdateSpecProperties
ApiSpecSyncOptions
GetSpecFiles	Information about the specification's files.
SpecFileInformation	Information about the API specification file.
CreateUpdateSpecFileResponse	Information about the API specification file.
CreateSpecFile
GetSpecFile	Information about the API specification file.
UpdateSpecFile	You must pass one of the accepted values in this request body. Also, this request body does not accept multiple properties in a single call. For example, you cannot pass both the `content` and `type` property at the same time.
GetSpecCollections
SpecCollectionInformation	Information about the API specification's collection.
ElementTypeCollection
GenerateCollection
GenerateCollectionOptions	The advanced creation options and their values. For more details, see Postman's OpenAPI to Postman Collection Converter OPTIONS documentation. These properties are case-sensitive.
GetSpecVersionTag
GetSpecVersionTags
GetSpecVersionTagsMeta
CreateSpecVersionTagResponse
CreateSpecVersionTag
SuccessResponse
ApiErrorNameMessage
ErrorTypeTitleDetailStatus
ErrorTypeTitleDetailStatusInstance
UpdateTags
ApiTag400Error1
GetTaggedEntitiesOkResponse
AscDescDefaultDesc
TagsEntityType
GetTaggedEntitiesBadRequestResponse
GetAuditLogs
AuditLogEvent	Information about the audit log event.
AuditLogData	Information about the audit log.
AuditLogActor	Information about the user who preformed the audit event.
AuditLogUser	Information about the user.
AuditLogTeam	The user's team information.
AscDescDefaultDesc
GetAuditLogEventActionsClientErrorResponse
AuditLogAction	Information about the audit log event action.
CollectionAccessKeys
CreateApiClientErrorResponse
ErrorTypeTitleDetailStatus
ErrorNameMessageDetails
DeleteCollectionAccessKeyNotFoundResponse
AsyncMergePullCollectionForkOkResponse
MergePullCollectionChanges
ErrorTypeTitleDetailStatus
TaskStatusResponse
CollectionsList
MetaLimitOffsetTotal	The response's meta information for paginated results.
CollectionCreated
CreateCollection
CreateCollectionSchema
CreateCollectionSchemaInfo	Information about the collection.
CreateCollectionSchemaItem	Information about the collection request or folder.
Variable	Information about the variable.
CreateCollectionSchemaEvent	Information about the collection's events.
EventScript	Information about the Javascript code that can be used to to perform setup or teardown operations in a response.
ResponseOriginalRequest1	Information about the collection request.
CreateCollectionSchemaAuth	The authorization type supported by Postman.
AuthAttributes	Information about the supported Postman authorization type.
ResponseHeader2_1	Information about the header.
ItemResponse1	Information about the request's response.
ProtocolProfileBehavior	The settings used to alter the Protocol Profile Behavior of sending a request.
ErrorNameMessageDetails
UsersForkedCollections
AscDesc
GetCollectionsForkedByUserBadRequestResponse
CollectionForkCreated
CreateCollectionFork
CollectionForkMerged
MergeCollectionFork
CollectionInformation
CollectionItem	Information about the collection request or folder.
VariableList2_1	Information about the variable.
SecretVariableInfo	Information about the secret variable.
EnvironmentVariableSource	Information about the source of the variable's value.
CollectionEvent	Information about the collection's events.
RequestEventsScript	Information about the Javascript code that can be used to to perform setup or teardown operations in a response.
ResponseOriginalRequest2	Information about the collection request.
CollectionAuth	The authorization type supported by Postman.
ResponseHeader2_2	Information about the header.
ItemResponse2	Information about the request's response.
CollectionModelQuery
GetAuditLogEventActionsClientErrorResponse
PutCollectionOkResponse
Prefer
ReplaceCollectionData
ModifyCollectionSchema
ModifyCollectionSchemaInfo	Information about the collection.
CollectionUpdatedAsync
PatchCollectionOkResponse
UpdateCollection
CollectionDeleted
CommentResponseObject
CommentUpdatedCreatedObject
CommentCreate	Information about the comment.
CommentUpdate	Information about the comment.
DuplicateCollectionResponse
DuplicateCollection
CollectionForksInfo
GetCollectionForksNotFoundResponse
PublishDocumentationResponse
DocumentationCustomizationSettings	Information about the documentation's customization.
DocumentationMetaTags
DocumentationApperanceSettings	Information about the documentation appearance, such as colors and theme.
DocumentationThemeSettings
DocumentationColorSettings	The theme's colors, in six digit hexcode. The values in this object must match the hexcode values of either the `light` or `dark` theme defined in the `appearance` object.
PublishDocumentation
CollectionChangesPulled
CollectionPullRequests
PullRequestCreated
CreatePullRequest	Information about the pull request.
CollectionRolesInfo	Information about the collection's roles.
ErrorTitleType
UpdateCollectionRoles
SourceCollectionStatus
GetSourceCollectionStatusBadRequestResponse
CollectionTransformed
CollectionTransformFormat
ErrorTypeTitleDetailStatusInstance
CollectionItemsTransferred
TransferCollectionItems
CreateApiClientErrorResponse
GetCollectionUpdateStatus
CollectionFolderCreated
CreateFolder	Information about the collection folder. For a complete list of properties, refer to the Postman Collection Format documentation. 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.
ErrorNameMessageDetails
CollectionRequestCreated
CreateRequest	Information about the request. For a complete list of properties, refer to the Request property in the Postman Collection Format documentation. 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.
RequestMethod	The request's HTTP method.
RequestHeaderData
RequestQueryParams
RequestData
RequestGraphqlModeData	The request body's GraphQL mode data.
RequestDataOptions	Additional configurations and options set for the request body's various data modes.
RequestAuth	The request's authentication information.
AuthAttributes	Information about the supported Postman authorization type.
RequestEvents
RequestEventsScript	Information about the Javascript code that can be used to to perform setup or teardown operations in a response.
CreateCollectionResponseOkResponse
CreateCollectionResponseRequest	Information about the response. For a complete list of properties, refer to the Response entry in the Postman Collection Format documentation. 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.
ResponseHeader2_2	Information about the header.
CollectionFolderInfo
CollectionFolderUpdated
UpdateFolder	The folder properties to update. For a complete list of properties, refer to the Postman Collection Format documentation.
CollectionFolderDeleted
CollectionRequestInfo
CollectionRequestUpdated
UpdateRequest	The request properties to update. For a complete list of properties, refer to the Request property in the Postman Collection Format documentation.
CollectionRequestDeleted
CollectionResponseInfo
CollectionResponseUpdated
UpdateCollectionResponse1	The response properties to update. For a complete list of properties, refer to the Response entry in the Postman Collection Format documentation.
CollectionResponseDeleted
CommentResponseObject
ErrorTypeTitleDetailStatus
CommentUpdatedCreatedObject
CommentCreate	Information about the comment.
CommentUpdate	Information about the comment.
CommentResponseObject
ErrorTypeTitleDetailStatus
CommentUpdatedCreatedObject
CommentCreate	Information about the comment.
CommentUpdate	Information about the comment.
CommentResponseObject
ErrorTypeTitleDetailStatus
CommentUpdatedCreatedObject
CommentCreate	Information about the comment.
CommentUpdate	Information about the comment.
ErrorTypeTitleDetailStatus
GetAllComponents
GetSpecVersionTagsMeta
ComponentData	Information about the component.
ComponentType	The component's type. Corresponds to the specification that the component's content adheres to.
ComponentStatus	The component's lifecycle state: - `active` — The component is active and can be edited and published. - `archived` — The component is archived and read-only. Archived components can't be edited or published, but their existing versions remain accessible.
ComponentVersionData	Information about a component's version.
ComponentHasVersions
ErrorTypeTitleDetailStatus
CreateComponentResponse	Information about the component.
CreateComponent
ComponentContentFormat	The component's content format.
GetComponent
UpdateComponentResponse	Information about the component.
GetComponentDraft
UpdateComponentDraftResponse	Information about the component draft.
UpdateComponentDraft	Information about the component draft.
GetComponentVersions
CreateComponentVersionResponse	Information about the component version.
CreateComponentVersion
SearchDetectedSecretsRequest
DetectedSecretsQueryRequest
ErrorTypeTitleStatusInstance
ErrorTypeTitleDetailStatusInstance
ErrorTypeTitleDetailStatus
UpdateDetectedSecretResolutionsOkResponse
UpdateSecretResolutionRequest
GetDetectedSecretsLocationsOkResponse
ResourceType
GetSecretTypesOkResponse
GetEnvironmentsOkResponse
GetEnvironmentsInfo	Information about the environment.
ErrorTypeTitleDetailStatusInstance
GetAuditLogEventActionsClientErrorResponse
EnvironmentCreated
CreateEnvironment
AddVariable	Information about the variable.
AddSecretVariable	Information about the variable stored in the Postman Vault. This property only returns when a variable is defined as secret.
EnvironmentVariableSource	Information about the source of the variable's value.
ErrorNameMessageDetails
GetEnvironmentOkResponse
GetEnvironmentInfo	Information about the environment.
PutEnvironmentOkResponse
ReplaceEnvironmentData
PatchEnvironmentOkResponse
PatchEnvironmentInfo	Information about the environment.
PatchEnvironmentAdd
PatchEnvironmentName	Information about the environment.
PatchEnvironmentReplace
PatchEnvironmentRemove
PatchEnvironmentBadRequestResponse
EnvironmentDeleted
GetEnvironmentForksOkResponse
EnvironmentForkInfo	Information about the forked environment.
EnvironmentForksMeta	The response's meta information for paginated results.
AscDesc
SortByCreatedAt
CreateApiClientErrorResponse
ErrorTypeTitleDetailStatus
ForkEnvironmentOkResponse
ForkEnvironment
MergeEnvironmentForkOkResponse
MergeEnvironmentFork
PullEnvironmentOkResponse
PullEnvironmentForkChanges
PostmanGroupsInformation
PostmanGroupInformation	Information about the group.
ErrorTypeTitleDetailStatus
ImportOpenApiDefinitionOkResponse
JsonSchema
GenerateCollectionOptions	The advanced creation options and their values. For more details, see Postman's OpenAPI to Postman Collection Converter OPTIONS documentation. These properties are case-sensitive.
JsonStringified
ImportExportFile
GetAuditLogEventActionsClientErrorResponse
ErrorNameMessageDetails
InvitePartnerResponse
RemovePartnerResponse
InvitePartners	Invite partners to a Partner Workspace.
ManagePartnerWorkspaceInvitesTargetObjectEmails	The target on which to perform the action.
RemovePartners	The request body for removing partners from a Partner Workspace.
RemovePartnerFromPartnership	The request body for removing partners from partnership with a team.
ErrorTypeTitleDetailStatus
GetWorkspacesOkResponse
GetWorkspacesWorkspaceData	Information about the workspace.
GetWorkspacesScimObject	An object containing SCIM user IDs. This object only returns if you pass the `include=scim` query parameter.
WorkspaceTypeQuery
WorkspaceIncludeQuery
WorkspaceElementTypeQuery
Workspaces400Error1
Workspaces400Error2
GetAuditLogEventActionsClientErrorResponse
CreateWorkspaceOkResponse
CreateWorkspace
Forbidden
GetAllWorkspaceRolesOkResponse
WorkspaceRoleData	Information about the role.
GetWorkspaceOkResponse
GetWorkspaceNotFoundResponse
WorkspaceUpdated
UpdateWorkspaceRequest
WorkspaceDeleted
WorkspaceActivityFeed
GetSpecVersionTagsMeta
ElementType3
TransferWorkspaceElementResponse
TransferWorkspaceElement
GetWorkspaceGlobalVariablesOkResponse	Information about the workspace's global variables.
GlobalVariableInfo	Information about the global variable.
CreateApiClientErrorResponse
GlobalVariablesUpdated	Information about the workspace's updated global variables.
UpdateGlobalVariables
WorkspaceRoles	Information about the workspace's roles.
WorkspaceRolesData
WorkspaceIncludeScimQuery
WorkspaceRolesUpdated
UpdateWorkspaceRoles
PartnerAndPersonalWorkspaceRolesUnsupported
TransferWorkspaceToTeamResponse
TransferWorkspaceToTeamResponseObject	Information about the workspace transfer.
TransferWorkspaceToTeam
GetWorkspaceUpdates
WorkspaceUpdateData	Information about the workspace update.
WorkspaceUpdateCreatedByData	Information about the user that created the workspace update.
WorkspaceUpdateCategoryData	The update's assigned category.
WorkspaceUpdateRelatedResourcesData
ErrorTypeTitleDetailStatusInstance
WorkspaceUpdatePostPatchResponseData
CreateWorkspaceUpdate
UpdateWorkspaceUpdate
GetAuthenticatedUserOkResponse
TeamUsersInformation
UserInformation	Information about the user.
ErrorTypeTitleDetailStatus
GetMockServers
InternalServerError
MockCreateUpdateResponse
CreateMock
GetMockServer
ErrorNameMessageDetails
UpdateMock
GetAuditLogEventActionsClientErrorResponse
MockDeleted
GetCallLogs
MockSortServedAt
AscDesc
MockPublishedUnpublished
GetMockServerResponses	Information about the server response.
GetMockServerResponsesNotFoundResponse
CreateMockServerResponseOkResponse	Information about the mock server's response.
CreateMockServerResponse
UpdateMockServerResponse
ServerResponseDeleted	Information about the deleted server response.
GetMonitorsOkResponse
GetAuditLogEventActionsClientErrorResponse
ErrorNameMessageDetails
CreateUpdateMonitorResponse
CreateMonitor
MonitorRetrySettings	Information about the monitor's retry settings.
MonitorOptions	Information about the monitor's option settings.
MonitorSchedule	Information about the monitor's schedule.
MonitorDistribution
MonitorNotifications	Information about the monitor's notification settings.
GetMonitorOkResponse
MonitorLastRun	Information about the monitor's previous run.
MonitorRunStats	Information about the monitor run's stats.
UpdateMonitor
MonitorDeleted
RunMonitorOkResponse
MonitorRunInformation	Information about the monitor.
MonitorRunExecutions
MonitorRunRequests	Information about the monitor run's requests.
MonitorRunResponses	Information about the monitor run's response.
MonitorRunErrors
RunExceeds300Seconds
GetRunnerInstances
RunnerMeta	The response's meta information for paginated results.
RunnerInstanceData	Information about the runner instance.
ErrorTypeTitleDetailCreatedAt
GetRunnerMetrics	The runner instance's metrics information.
ListPrivateNetworkWorkspacesOkResponse
Meta	The response's non-standard meta information.
ElementTypeQuery
SortCreatedUpdatedAt
AscDesc
ElementCreated	Information about the Private API Network element.
AddWorkspace
AddWorkspaceToPrivateNetworkNotFoundResponse
UpdatePanElementOrFolderRequest
RemoveWorkspaceFromPrivateNetworkOkResponse
GetAuditLogEventActionsClientErrorResponse
ListPrivateNetworkAddRequestsOkResponse
PanRequestElement	Information about the requested element.
PanRequestResponse	Information about the response to the element's request. This object only returns when the request is denied with a message.
PanRequestStatus
RequestApproved
RequestDenied
RespondPanElementAddRequestBody
GenerateOauthTokenResponse
GenerateOauthToken
OauthTokenError
RevokeOauthTokenResponse
RevokeOauthToken
GenerateToolResponse
GenerateTool
GenerateToolBadRequestResponse
ErrorTypeTitleDetailStatus
GetPullRequestOkResponse
ErrorTypeTitleDetailStatus
PullRequestUpdated
UpdatePullRequest
ReviewPullRequestOkResponse
ReviewPullRequest
SchemaSecurityValidationOkResponse
SchemaValidationRequestBody
SchemaSecurityValidationBadRequestResponse
GetScimGroupResourcesOkResponse
ScimGroupResource	The SCIM group resource object.
ScimErrorSchemasDetailStatus
ScimGroupCreated
CreateScimGroup
ScimErrorSchemasScimTypeDetailStatus
GetScimGroupResourceOkResponse
ScimGroupUpdated
UpdateScimGroup
GetScimResourceTypes
GetScimServiceProviderConfigOkResponse	Information about Postman's SCIM API configurations and supported operations.
ScimUsers
Resources	The SCIM user resource object.
ScimUserCreated
CreateScimUser
GetScimUserResourceOkResponse
UpdateScimUserRequest
SdkList
Sdk	Information about the generated SDK.
SdkLanguage	The target output language for the generated SDK.
SdkSource	The collection or specification that the SDK is generated from.
ElementType2	The type of Postman element.
SdkBuildStatus	The SDK's build lifecycle: - `queued` — Accepted but not yet started. - `in_progress` — The SDK generation is running and in progress. - `succeeded` — The archive is built and available for download. - `failed` — The SDK generation failed. For information, check the `error` response.
SdkErrorBuildStatusFailure	Information about the SDK build's status when `buildStatus` is `failed`.
SimpleSdkGitConnectionPullRequest
SdkGitConnectionPrStatus	The lifecycle status of a pull request.
MetaNextCursorTotal	The response's meta information for paginated results.
SdkError
ErrorTypeTitleDetailStatus
CreateSdk	Note: - Only the object passed in the request body that matches the value in the `language` property gets read, and all other objects are ignored. - The language option object is optional. When the language identifier is omitted, it's derived from the `source` element name and its workspace.
SdkAuthorData	Information about the author of the generated SDK.
SdkRetryOptions	Retry behavior baked into the generated SDK's HTTP client. A power-user option; sensible defaults apply for any field left unset.
TypescriptOptions	TypeScript-specific SDK generation options.
PythonOptions	Python-specific SDK generation options.
GoOptions	Go-specific SDK generation options.
JavaOptions	Java-specific SDK generation options.
CsharpOptions	C#-specific SDK generation options.
RubyOptions	Ruby-specific generation options.
PhpOptions	PHP-specific SDK generation options.
KotlinOptions	Kotlin-specific SDK generation options.
RustOptions	Rust-specific SDK generation options.
CliOptions	CLI-specific SDK generation options.
SdkDownload
SdkGitConnectionList
SdkGitConnection	Information about the SDK's Git connection to a Postman element.
SdkGitConnectionStatus	The lifecycle status of the Git connection: - `active` — The connection is live and all opened pull requests ship SDK updates into the repository. - `disconnected` — The connection was explicitly disconnected by the owner, and no pull requests can be opened. The historical record is preserved. - `inaccessible` — Access to the repository was revoked or its no longer reachable.
CreateSdkGitConnection
UpdateSdkGitConnection
SdkGitConnectionPullRequestList
SdkGitConnectionPullRequest	Information about a pull request that shipped the SDK update.
SearchPostmanResourcesResponse
SearchMetaData	Pagination metadata for the search results.
SearchPostmanResourcesResponseData	Information about the Postman resource.
SearchResourceTeamData	Information about the team associated with the resource. This returns a null value for the `user` publisher type.
SearchRequestsCollectionData	Information about the collection containing the resource. Returns only for requests.
SearchResourceWorkspacesData	Information about the workspace containing the resource.
SearchResourceOrganizationData	Information about the organization that published the resource. This returns a null value for the `user` publisher type.
SearchResourceLinksData	Information about the resource's hypermedia links.
SearchResourceWebData	The link to view the resource in the Postman web app.
SearchResourceLinksSelfData	The link to the resource through the Postman API.
SearchPostmanResources
SearchFilters	A single filter condition.
SearchFilterPrivateApiNetwork	Filters by private API network membership. Supported for all element types.
SearchFilterPublisherIsVerified	Filters by publisher verification status. Supported for all element types.
SearchFilterVisibility	Filters by workspace visibility. Supported for all element types. One of: - `internal` — Only visible to the organization's team members. - `public` — Visible to all Postman users. - `partner` — Visible to assigned external partner users.
SearchFilterWorkspaceId	Filters by workspace ID. Supported for all element types.
SearchFilterCollectionId	Filters by collection ID. Supported for `requests` and `collections` only.
SearchFilterTags	Filters by tags. Supported for `workspaces` and `collections`.
SearchFilterRequestHttpMethod	Filters by HTTP method (for example, `GET` or `POST`). Supported for `requests` only.
SearchFilterRequestId	Filters by request ID. Supported for `requests` only.
SearchFilterSpecId	Filters by specification ID. Supported for `specs` only.
SearchFilterFlowId	Filters by flow ID. Supported for `flows` only.
SearchFilterEnvironmentId	Filters by environment ID. Supported for `environments` only.
SearchFilterCreatedBy	Filters by the resource creator's user ID. Supported for all element types.
SearchFilterOrgId	Filters by organization ID. Supported for all element types.
SearchFilterTeamId	Filters by team ID. Supported for all element types.
SearchFilterGitConnected	Filters by Git connection status. Supported for `workspaces`, `collections`, `requests`, `environments`, `specs`, and `flows`.
SearchFilterRequestResourceType	Filters by resource type variant (for example, `http` or `grpc`). Supported for `requests` only.
ErrorTypeTitleDetailStatus
GenerateServiceAccountTokenResponse
ErrorTypeTitleDetailStatus
ErrorTypeTitleDetailStatusInstance
GetTeams
TeamData	Information about the team.
GetTeamsMetadata	The response's meta information for paginated results.
TeamsApiErrorSchema
ErrorDetails	An explanation about the problem.
InvalidEntriesForManageTeamMemberRoles	An explanation about the problem.
ErrorTypeTitleDetailStatusInstance
CreateGetTeamResponse
CreateTeam
TeamsInclude
GetTeamAccessRequests
CreateAccessRequestResponse
TeamsAccessRequestData
CreateAccessRequest
TeamEntityInfo
ApproveDenyAccessRequestResponse
ApproveDenyAccessRequest
ManageTeamMemberRolesResponse
ManageTeamMemberRoles	Information about the bulk add and bulk remove operations.
ManageTeamMemberRolesAdd	Information about the bulk `add` operation.
UsersInfo
TeamRoles
UserGroupsInfo
OrgsInfo
TeamsInfo
ManageTeamMemberRolesRemove	Information about the bulk `remove` operation.
RemoveTeamMembers
CreateGetTeamSettingsResponse
UpdateTeamSettings
WebhookCreated
CreateWebhook
ErrorNameMessageDetails

Name		Name	Last commit message	Last commit date
Latest commit History 1 Commit
.github		.github
documentation		documentation
examples		examples
scripts		scripts
src		src
tests		tests
.env.example		.env.example
.gitignore		.gitignore
.manifest.json		.manifest.json
LICENSE		LICENSE
README.md		README.md
package-lock.json		package-lock.json
package.json		package.json
prettier.config.js		prettier.config.js
tsconfig.json		tsconfig.json

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Repository files navigation

PostmanApi TypeScript SDK 1.44.1

Versions

About the API

Getting started

EU users

About the Postman API

IDs and UIDs

Enum values

403 response for unavailable features

503 response

Authentication

SCIM authentication

Authentication error response

Rate and usage limits

Support

Policies

Table of Contents

Setup & Configuration

Supported Language Versions

Installation

Authentication

Basic Authentication

Setting the Username and Password

API Key Authentication

Setting the API key

Setting a Custom Timeout

Sample Usage

Services

Models

About

Releases

Packages

Contributors

Languages

Uh oh!

Folders and files

Latest commit

History

Repository files navigation

PostmanApi TypeScript SDK 1.44.1

Versions

About the API

Getting started

EU users

About the Postman API

IDs and UIDs

Enum values

403 response for unavailable features

503 response

Authentication

SCIM authentication

Authentication error response

Rate and usage limits

Support

Policies

Table of Contents

Setup & Configuration

Supported Language Versions

Installation

Authentication

Basic Authentication

Setting the Username and Password

API Key Authentication

Setting the API key

Setting a Custom Timeout

Sample Usage

Services

Models

About

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages