Get discovered services

GET

/api-catalog/discovery-services

GET

/api-catalog/discovery-services

$ curl https://api.getpostman.com/api-catalog/discovery-services \
>      -H "x-api-key: <apiKey>"

1 {
2   "meta": {
3     "total": 5,
4     "nextCursor": null
5   },
6   "data": [
7     {
8       "id": "0eac9b7d-0603-4f16-8a4a-76c78df8fe26",
9       "name": "Supply - stage (1.0.1)",
10       "version": "1.0.1",
11       "sourceEnvironment": "stage",
12       "systemEnvironmentId": null,
13       "status": "discovered",
14       "endpointsCount": 6,
15       "discoverySource": "api_gateway_app",
16       "tags": [],
17       "discoveredAt": "2026-02-12T04:01:26.000Z"
18     },
19     {
20       "id": "0eab2aa4-d39b-49eb-a17b-d6c7b7eb9c9d",
21       "name": "Order - stage (3.0.0)",
22       "version": "3.0.0",
23       "sourceEnvironment": "stage",
24       "systemEnvironmentId": null,
25       "status": "discovered",
26       "endpointsCount": 2,
27       "discoverySource": "api_gateway_app",
28       "tags": [],
29       "discoveredAt": "2026-02-12T04:01:26.000Z"
30     },
31     {
32       "id": "a6aa80f3-bc34-4314-abc4-22c4fc5fd15d",
33       "name": "Jelly Bean Wiki (IBM - 9) - sandbox (1.0.0)",
34       "version": "1.0.0",
35       "sourceEnvironment": "sandbox",
36       "systemEnvironmentId": null,
37       "status": "discovered",
38       "endpointsCount": 3,
39       "discoverySource": "api_gateway_app",
40       "tags": [],
41       "discoveredAt": "2026-02-12T04:01:26.000Z"
42     },
43     {
44       "id": "5f5bda12-63e2-47d2-8824-ed5889de571a",
45       "name": "Jelly Bean Wiki (IBM - 8) - sandbox (1.0.0)",
46       "version": "1.0.0",
47       "sourceEnvironment": "sandbox",
48       "systemEnvironmentId": null,
49       "status": "discovered",
50       "endpointsCount": 3,
51       "discoverySource": "api_gateway_app",
52       "tags": [],
53       "discoveredAt": "2026-02-12T04:01:26.000Z"
54     },
55     {
56       "id": "339f3be5-0a91-47d5-a8c3-90d644752f5e",
57       "name": "Jelly Bean Wiki (IBM - 7) - sandbox (1.0.0)",
58       "version": "1.0.0",
59       "sourceEnvironment": null,
60       "systemEnvironmentId": null,
61       "status": "discovered",
62       "endpointsCount": 3,
63       "discoverySource": "api_gateway_app",
64       "tags": [],
65       "discoveredAt": "2026-02-12T04:01:26.000Z"
66     }
67   ]
68 }

Gets a list of all discovered services in the API Catalog.

Gets a list of all [discovered services](https://learning.postman.com/docs/api-catalog/overview#discover-apis-and-services) in the API Catalog.

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

discoverySourceenumOptional

Filter results by the given discovery source type:

api_gateway_app — API Gateway integrations.
insights_project — Postman Insights.
infra_watcher — Cluster Watcher.
public_api — Services manually added using the POST /api-catalog/discovery-services endpoint.

Filter results by the given discovery source type: - `api_gateway_app` — API Gateway integrations. - `insights_project` — Postman Insights. - `infra_watcher` — Cluster Watcher. - `public_api` — Services manually added using the POST `/api-catalog/discovery-services` endpoint.

Allowed values:

statusstringOptional

A comma-separated list of statuses to filter the results by. Accepts the discovered, integrated, and archived values.

searchstringOptional

Filter results by the given value that match a service’s name. Matching is not case-sensitive.

limitintegerOptional1-100Defaults to 20

The maximum number of rows to return in the response, up to a maximum value of 100. Any value greater than 100 returns a 400 Bad Request response.

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.

Response

Successful Response

metaobject

The response's meta information for paginated results.

datalist of objects

A list of discovered services.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error