Get a discovered service's information

GET

/api-catalog/discovery-services/:serviceId

GET

/api-catalog/discovery-services/:serviceId

$ curl https://api.getpostman.com/api-catalog/discovery-services/c6ec74e7-14f8-498c-9470-7a654173bed6 \
>      -H "x-api-key: <apiKey>"

1 {
2   "id": "c6ec74e7-14f8-498c-9470-7a654173bed6",
3   "organizationId": 123,
4   "discoverySource": "api_gateway_app",
5   "name": "Jelly Bean Wiki (IBM - 10) - sandbox (1.0.0)",
6   "description": null,
7   "version": "1.0.0",
8   "sourceEnvironment": "sandbox",
9   "systemEnvironmentId": null,
10   "tags": [],
11   "status": "discovered",
12   "providerServiceId": "048840c0-1be8-4d9f-a8a6-7429ca50f5ca,989213fc-b1a3-42cb-b0d6-b7843ee5d47d,40d57331-ad73-47a3-87f0-032af447df8e",
13   "providerMetadata": {
14     "title": "Jelly Bean Wiki (IBM - 10) - sandbox (1.0.0)",
15     "environmentId": "048840c0-1be8-4d9f-a8a6-7429ca50f5ca,989213fc-b1a3-42cb-b0d6-b7843ee5d47d",
16     "environmentVersion": "2.0.0",
17     "openApiSpecCanBeDownloaded": true
18   },
19   "apiDefinition": {
20     "format": "openapi_3",
21     "formatVersion": "3.0.1",
22     "contentHash": "8839a589ba50f454a03f58ec761ad26e2d267a8f26bd63cf6298d4643b23ed7e",
23     "content": "eyJvcGVuYXBpIjoiMy4wLjAiLCJpbmZvIjp7InRpdGxlIjoiQ29uZmlnIiwidmVyc2lvbiI6IjEuMC4wIn0sInBhdGhzIjp7Ii9jb25maWciOnsiZ2V0Ijp7InN1bW1hcnkiOiJHZXQgY29uZmlnIn19LCIvY29uZmlnL3trZXl9Ijp7InB1dCI6eyJzdW1tYXJ5IjoiVXBkYXRlIGNvbmZpZyJ9fX19="
24   },
25   "endpoints": [
26     {
27       "method": "GET",
28       "path": "/api/recipes",
29       "description": null
30     },
31     {
32       "method": "GET",
33       "path": "/api/mileStones",
34       "description": null
35     },
36     {
37       "method": "GET",
38       "path": "/api/Beans",
39       "description": null
40     }
41   ],
42   "endpointsCount": 3,
43   "discoveredAt": "2026-02-12T02:04:58.000Z",
44   "discoveredBy": 12345678,
45   "lastSyncedAt": "2026-02-12T02:04:58.000Z",
46   "managedWorkspaceId": null,
47   "integratedAt": null
48 }

Gets detailed information about a discovered service, including a base64-encoded OpenAPI specification and an array of endpoints.

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

Path parameters

serviceIdstringRequired

The discovered service's ID.

Response

Successful Response

idstring

The service's ID.

organizationIdinteger

The ID of the organization that the service belongs to.

discoverySourcestring

The source through which the service was discovered.

namestring

The servie's name.

descriptionstring or null

The service's description.

versionstring

The service's version.

sourceEnvironmentstring or null

The source environment in which the service was discovered.

systemEnvironmentIdstring or null

The mapped system environment's ID. Returns a null value if the environment is not mapped.

tagslist of strings

A list of tags associated with the service.

statusstring

The service's current status.

providerServiceIdstring

The ID of the service in the source registry.

providerMetadataobject

Additional metadata from the discovery source provider.

apiDefinitionobject

The API definition associated with the service.

endpointslist of objects

A list of the service's endpoints.

endpointsCountinteger

The total number of endpoints associated with the service.

discoveredAtdatetime

The date and time at which the service was first discovered.

discoveredByinteger

The user ID of the user who discovered or ingested the service.

lastSyncedAtdatetime

The date and time of the most recent service sync.

managedWorkspaceIdstring or null

The ID of the Postman workspace that the service has been integrated into. Returns a null value if the service is not integrated.

integratedAtdatetime or null

The date and time at which the service was linked to a Postman workspace. Returns a null value if the service is not integrated.

Errors

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error