Postman

Official

Overview Schema Source Related Servers Discussions Admin

searchPostmanElements

Read-onlyIdempotent

Search Postman entities like requests, collections, workspaces, specs, flows, environments, mocks, and documents. Use filters and ownership scopes to locate internal or external APIs by query.

Instructions

Search for Postman entities (requests, collections, workspaces, specs, flows, environments, mocks, and documents).

Ownership:

organization — Search within all resources owned by your organization (default).
external — Search within the public Postman network (third-party and community APIs).
all — Search across all scopes.

When to use each ownership value and filters:

Goal	Recommended approach
Find an internal API (e.g. "our notification service")	`ownership: organization`
Find a trusted API published to the Private Network	`ownership: organization` + `privateNetwork: true` filter
Find an internal API in all resources of organization and are visible to the organization only	`ownership: organization` + `visibility: internal` filter
Find an API by your organization that is made publicly visible	`ownership: organization` + `visibility: public` filter
Find a third party publicly visible API (e.g. "Stripe API", "Twilio API")	`ownership: external` + `visibility: public` filter
User says "our APIs", "internal", "team"	`ownership: organization`
Search across all scopes	`ownership: all`

Element Types:

requests: Search for individual API requests.
collections: Search for API collections.
workspaces: Search for Postman workspaces.
specs: Search for API specifications.
flows: Search for Postman Flows.
environments: Search for Postman Environments.
mocks: Search for Postman Mock Servers.
documents: Search for Postman workspace documents.

Filters:

Use the filters parameter to narrow results. The top-level key must be $and with an array of condition objects. Each condition object must contain exactly one field key.

Supported filter fields:

Field	Operators	Notes
`workspaceId`	`$eq`, `$ne`, `$in`, `$nin`	All element types. `$in`/`$nin` accept arrays.
`collectionId`	`$eq`, `$ne`, `$in`, `$nin`	Requests and collections only.
`visibility`	`$eq`, `$ne`	Values: `public`, `partner`, `internal`. All element types.
`privateNetwork`	`$eq`, `$ne`	Boolean. All element types.
`publisherIsVerified`	`$eq`, `$ne`	Boolean. All element types.
`method`	`$eq`, `$ne`, `$in`, `$nin`	HTTP methods (GET, POST, etc.). Requests only.
`tags`	`$eq`, `$ne`, `$in`, `$nin`	Workspaces and collections only.
`requestId`	`$eq`, `$ne`, `$in`, `$nin`	Requests only.
`specificationId`	`$eq`, `$ne`, `$in`, `$nin`	Specs only.
`flowId`	`$eq`, `$ne`, `$in`, `$nin`	Flows only.
`documentId`	`$eq`, `$ne`, `$in`, `$nin`	Documents only.
`createdBy`	`$eq`, `$ne`, `$in`, `$nin`	All element types.
`organizationId`	`$eq`, `$ne`, `$in`, `$nin`	All element types.
`teamId`	`$eq`, `$ne`, `$in`, `$nin`	All element types.
`isGitConnected`	`$eq`, `$ne`	Boolean. Workspaces, collections, requests, specs, flows, environments, mocks, documents.
`type`	`$eq`, `$ne`, `$in`, `$nin`	Requests only.

Filter examples:

Private API Network only: {"$and":[{"privateNetwork":{"$eq":true}}]}
Single workspace: {"$and":[{"workspaceId":{"$eq":"ws-abc123"}}]}
Multiple workspaces: {"$and":[{"workspaceId":{"$in":["ws-1","ws-2"]}}]}
Public visibility: {"$and":[{"visibility":{"$eq":"public"}}]}
GET requests only: {"$and":[{"method":{"$eq":"GET"}}]}
Combine conditions: {"$and":[{"visibility":{"$eq":"public"}},{"workspaceId":{"$eq":"ws-abc123"}}]}
Environments in a workspace: {"$and":[{"workspaceId":{"$eq":"ws-abc123"}}]}

Input Schema

TableJSON Schema

Name	Required	Description	Default
`q`	No	The search query (e.g. "payment API", "notification service", "Stripe").
`limit`	No	The maximum number of search results to return. Maximum: 25.
`cursor`	No	The cursor to get the next set of results in the paginated response. Pass the `nextCursor` value from the previous response.
`filters`	No	Structured filter expression. Top-level key must be "$and" with an array of condition objects. Each condition: { "<field>": { "<operator>": <value> } }. Example: {"$and":[{"privateNetwork":{"$eq":true}}]}
`ownership`	No	The ownership scope. Use `organization` to search all resources in your organization (default), `external` to search the public Postman network, or `all` to search across all scopes.	organization
`entityType`	No	The type of Postman entity to search for: `requests` (individual API requests), `collections` (API collections), `workspaces` (Postman workspaces), `specs` (API specifications), `flows` (Postman Flows), `environments` (Postman Environments), `mocks` (Postman Mock Servers), or `documents` (Postman workspace documents).	requests

Schema Changelog

Changes observed during successful MCP inspections.

Changed3 schema fields changedv2.12.0Aug 19, 2026

changedInput schema / properties / entityType / description

Previous value: -"The type of Postman entity to search for: `requests` (individual API requests), `collections` (API collections), `workspaces` (Postman workspaces), `specs` (API specifications), `flows` (Postman Flows), `environments` (Postman Environments), or `mocks` (Postman Mock Servers)."New value: +"The type of Postman entity to search for: `requests` (individual API requests), `collections` (API collections), `workspaces` (Postman workspaces), `specs` (API specifications), `flows` (Postman Flows), `environments` (Postman Environments), `mocks` (Postman Mock Servers), or `documents` (Postman workspace documents)."

changedInput schema / properties / entityType / enum

Previous value: -[
-  "requests",
-  "collections",
-  "workspaces",
-  "specs",
-  "flows",
-  "environments",
-  "mocks"
-]New value: +[
+  "requests",
+  "collections",
+  "workspaces",
+  "specs",
+  "flows",
+  "environments",
+  "mocks",
+  "documents"
+]

addedInput schema / properties / filters / properties / $and / items / properties / documentId

Added value: +{
+  "$ref": "#/properties/filters/properties/$and/items/properties/workspaceId"
+}

Changed2 schema fields changedv2.9.1Jun 12, 2026

changedInput schema / properties / entityType / description

Previous value: -"The type of Postman entity to search for: `requests` (individual API requests), `collections` (API collections), `workspaces` (Postman workspaces), `specs` (API specifications), `flows` (Postman Flows), or `environments` (Postman Environments)."New value: +"The type of Postman entity to search for: `requests` (individual API requests), `collections` (API collections), `workspaces` (Postman workspaces), `specs` (API specifications), `flows` (Postman Flows), `environments` (Postman Environments), or `mocks` (Postman Mock Servers)."

changedInput schema / properties / entityType / enum

Previous value: -[
-  "requests",
-  "collections",
-  "workspaces",
-  "specs",
-  "flows",
-  "environments"
-]New value: +[
+  "requests",
+  "collections",
+  "workspaces",
+  "specs",
+  "flows",
+  "environments",
+  "mocks"
+]

Addedv2.9.0Jun 10, 2026

TDQS

A4.2/5.0

Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already establish readOnlyHint, idempotentHint, and destructiveHint, so the safety profile is covered. The description adds meaningful behavioral context by explaining ownership scopes, the $and filter structure, supported filter fields/operators, and concrete examples. It does not describe response shape or pagination details, but cursor is documented in the schema.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is long but front-loaded and organized with headings, tables, and examples, making dense filter rules scannable. Some content repeats the schema enums, but the repetition is justified given the complexity of the tool.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 6-parameter search tool with nested filter objects and no output schema, the description covers ownership, entity types, filter syntax, operator constraints, and usage goals thoroughly. The main omission is a statement about the shape or contents of the returned search results, which would be more critical without an output schema.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Even though schema description coverage is 100%, the description substantially exceeds the schema by providing a filter field/operator/element-type matrix, ownership decision table, and multiple JSON filter examples. This is material added meaning for the most complex parameter (filters) and for ownership/entityType selection.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with a specific verb and resource: 'Search for Postman entities' and enumerates all entity types plus ownership scopes, so an agent knows exactly what the tool searches. It does not explicitly contrast this search tool with sibling getters like getCollections or getWorkspaces, so it stops short of full sibling differentiation.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The 'When to use each ownership value and filters' table provides strong goal-to-parameter guidance, mapping phrases like 'our APIs' to ownership: organization and third-party APIs to external. It does not mention when to prefer sibling tools or state when-not-to-use conditions, so alternatives are not addressed.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

searchPostmanElements

Instructions

Input Schema

Schema Changelog

TDQS

Other Tools