Search Postman resources

POST

/search

POST

/search

$ curl -X POST https://api.getpostman.com/search \
>      -H "x-api-key: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "elementType": "workspaces",
>   "q": "test workspace",
>   "ownership": "organization",
>   "filters": {
>     "$and": [
>       {
>         "publisherIsVerified": {
>           "$ne": true
>         }
>       }
>     ]
>   }
> }'

1 {
2   "meta": {
3     "nextCursor": "eyJmcm9tIjoxMH0=",
4     "q": "team",
5     "total": 2
6   },
7   "data": [
8     {
9       "id": "12345678-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
10       "name": "Get Team Members",
11       "method": "GET",
12       "description": "Retrieve all team members",
13       "url": "https://postman-echo.com/get?team=api-team",
14       "createdBy": "12345678",
15       "team": {
16         "id": "123",
17         "name": "API Team Devs"
18       },
19       "isGitConnected": false,
20       "collection": {
21         "id": "12345678-11223344-5566-7788-99aa-bbccddeeff00",
22         "name": "API Team"
23       },
24       "workspace": {
25         "id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
26         "name": "API Team Workspace"
27       },
28       "organization": {
29         "id": "1",
30         "name": "API Team Devs",
31         "isVerified": false
32       },
33       "links": {
34         "web": {
35           "href": "https://go.postman.co/request/12345678-a1b2c3d4-e5f6-7890-abcd-ef1234567890"
36         },
37         "self": {
38           "href": "https://api.postman.com/collections/12345678-11223344-5566-7788-99aa-bbccddeeff00/requests/12345678-a1b2c3d4-e5f6-7890-abcd-ef1234567890"
39         }
40       }
41     },
42     {
43       "id": "12345678-f0e1d2c3-b4a5-9687-7654-321fedcba098",
44       "name": "Create Workspace",
45       "method": "POST",
46       "description": "Create workspace",
47       "url": "https://postman-echo.com/post",
48       "createdBy": "12345678",
49       "team": {
50         "id": "123",
51         "name": "API Team Devs"
52       },
53       "isGitConnected": false,
54       "collection": {
55         "id": "12345678-aabbccdd-eeff-0011-2233-445566778899",
56         "name": "Workspace Operations"
57       },
58       "workspace": {
59         "id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
60         "name": "API Team Workspace"
61       },
62       "organization": {
63         "id": "1",
64         "name": "API Team Devs",
65         "isVerified": false
66       },
67       "links": {
68         "web": {
69           "href": "https://go.postman.co/request/12345678-f0e1d2c3-b4a5-9687-7654-321fedcba098"
70         },
71         "self": {
72           "href": "https://api.postman.com/collections/12345678-aabbccdd-eeff-0011-2233-445566778899/requests/12345678-f0e1d2c3-b4a5-9687-7654-321fedcba098"
73         }
74       }
75     }
76   ]
77 }

Searches Postman for resources such as workspaces, collections, requests, and other resource types. You can filter results by ownership, visibility, tags, and other criteria.

Note:

If you call this endpoint without an API key, the response only returns publicly-available resources.

Authentication

x-api-keystring

API Key authentication via header

Authorizationstring

A valid SCIM API key for calls to SCIM endpoints.

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.

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Query parameters

limitintegerOptional1-25Defaults to 10

The maximum number of results to return per page.

cursorstringOptional

The pointer to the first record of the set of paginated results. To view the next response, use the nextCursor value for this parameter.

Request

This endpoint expects an object.

elementTypeenumRequired

The type of Postman resource to search for.

qstringOptional

The search query text. This is case-insensitive.

ownershipenumOptionalDefaults to organization

The ownership scope for search results. One of:

organization (default) — Resources owned by the user’s team.
external — Resources not owned by the user’s team.
all — All resources regardless of ownership.

filtersobjectOptional

The search filters to narrow results.

Response

Successful Response

metaobject

Pagination metadata for the search results.

datalist of objects

A list of Postman elements that match the search query and filters.

Errors

400

Bad Request Error

500

Internal Server Error