Skip to main content
Glama
postmanlabs

Postman

Official
by postmanlabs
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

Search Postman elements

searchPostmanElements
Read-onlyIdempotent

Search Postman requests, collections, workspaces, specs, flows, environments, mocks, and documents across your organization or the public network, with filters to narrow results.

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

NameRequiredDescriptionDefault
qNoThe search query (e.g. "payment API", "notification service", "Stripe").
limitNoThe maximum number of search results to return. Maximum: 25.
cursorNoThe cursor to get the next set of results in the paginated response. Pass the `nextCursor` value from the previous response.
filtersNoStructured filter expression. Top-level key must be "$and" with an array of condition objects. Each condition: { "<field>": { "<operator>": <value> } }. Example: {"$and":[{"privateNetwork":{"$eq":true}}]}
ownershipNoThe 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
entityTypeNoThe 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.

  1. Changed3 schema fields changedv2.12.0
    • 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"
+}
  2. Changed2 schema fields changedv2.9.1
    • 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"
+]
  3. Addedv2.9.0

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description adds behavioral scope semantics the annotations do not: the default ownership=organization restricts to your org versus external/public-network search, which materially changes result set. It stops short of describing pagination behavior.

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?

Front-loaded with purpose, then cleanly sectioned into ownership, element types, and filters with tables and examples. Some redundancy: the entityType and ownership definitions are restated nearly verbatim from the schema, which inflates length without adding new information.

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 definition covers scoping, element types, and filter syntax thoroughly. The one gap is that neither the description nor annotations explain result shape or how cursor pagination interacts with limit, though the schema documents the cursor field itself.

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

Parameters4/5

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

Schema description coverage is 100%, so baseline is 3, but the description adds semantics the schema does not encode: which element types each filter field is valid for (method = requests only, tags = workspaces/collections only) and worked filter-expression examples. That is genuine value beyond the schema's structural constraints.

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

Purpose5/5

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

States a specific verb (search) and enumerates the exact resource types it operates over (requests, collections, workspaces, specs, flows, environments, mocks, documents). An agent can distinguish this aggregate search tool from the many narrow getters in the sibling list (getCollections, getWorkspaces, getSpec) immediately.

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

Usage Guidelines5/5

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

The ownership table maps concrete user intents ("our notification service", "Stripe API", "our APIs") to specific parameter values, and the filter field table states which element types each filter applies to. This is explicit when-to-use guidance with alternatives, not inference.

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

Deploy Server

Other Tools