Skip to main content
Glama
postmanlabs

Postman

Official
by postmanlabs
OverviewSchemaRelated ServersScoreDiscussions
TypeScript
Hybrid

searchPostmanElements

Read-onlyIdempotent

Search Postman entities such as requests, collections, workspaces, specs, flows, environments, mocks, and documents by query and filters. Find internal or public API resources across your organization and the Postman network.

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
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

Tool Definition Quality

A4.6/5.0
Behavior5/5

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

Beyond the annotations (readOnly, idempotent, non-destructive), the description discloses extensive behavioral semantics: ownership scope meaning, filter structure with $and and operator rules, which filter fields apply to which element types, and examples of valid filter expressions. This goes well beyond what annotations convey.

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 extremely well-structured with clear sections, tables, and bullet points. Every part adds necessary information for a complex tool with nested filters and multiple entity types. It earns its length, though it could be slightly trimmed by avoiding some repetition with the schema.

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?

The description covers ownership, element types, filters, and examples comprehensively. It does not explicitly describe the response format or pagination behavior, but the cursor parameter in the schema hints at pagination. For a complex search tool with no output schema, this is nearly complete but leaves return structure implicit.

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?

Although schema coverage is 100%, the description adds substantial meaning beyond the schema: it explains ownership values with decision criteria, lists all element types with context, and provides a comprehensive filter field/operator table plus multiple examples. This is far more than the schema's per-parameter descriptions.

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?

The description clearly states it searches for Postman entities across multiple types (requests, collections, workspaces, etc.) and scopes (organization, external, all). The verb 'Search' and resource are specific, and the ownership scope distinguishes it from simple retrieval tools like getCollections or getWorkspaces.

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 description provides a detailed table mapping user goals to ownership values and recommended filters, which is clear contextual guidance. However, it does not explicitly name sibling tools as alternatives or say when not to use this tool in favor of a more specific getter, so it falls short of a full 5.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/postmanlabs/postman-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server