> For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://learning.postman.com/llms.txt.

# Get discovered services

GET https://api.postman.com/api-catalog/discovery-services

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

Reference: https://learning.postman.com/api-docs/api-reference/api-catalog/get-api-catalog-discovery-services

## Authentication

- `x-api-key` header (required)

## Servers

- `https://api.postman.com` (https://api.postman.com, default)
- `https://api.eu.postman.com` (https://api.eu.postman.com)

## Request

### Query parameters

- `discoverySource` (enum, optional) — 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: `api_gateway_app`, `insights_project`, `infra_watcher`, `public_api`
- `status` (string, optional) — A comma-separated list of statuses to filter the results by. Accepts the `discovered`, `integrated`, and `archived` values.
- `search` (string, optional) — Filter results by the given value that match a service's name. Matching is not case-sensitive.
- `limit` (integer, optional, default: 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.
- `cursor` (string, optional) — 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

### 200

Successful Response

- `meta` (object, optional) — The response's meta information for paginated results.
  - `total` (integer, optional) — The number of records found.
  - `nextCursor` (string, optional, nullable) — The pagination cursor that points to the next record in the results set.
- `data` (list of object, optional) — A list of discovered services.
  - `id` (string, optional) — The service's ID.
  - `name` (string, optional) — The service's name.
  - `version` (string, optional) — The service's version.
  - `sourceEnvironment` (string, optional, nullable) — The source environment in which the service was discovered.
  - `systemEnvironmentId` (string, optional, nullable) — The mapped system environment's ID. Returns a null value if the environment is not mapped.
  - `status` (string, optional) — The service's current status.
  - `endpointsCount` (integer, optional) — The total number of endpoints associated with the service.
  - `discoverySource` (string, optional) — The source through which the service was discovered.
  - `tags` (list of string, optional) — A list of tags associated with the service.
  - `discoveredAt` (datetime, optional) — The date and time at which the service was first discovered.

## Examples

### Successful Response

**Response**

```json
{
  "meta": {
    "total": 5,
    "nextCursor": null
  },
  "data": [
    {
      "id": "0eac9b7d-0603-4f16-8a4a-76c78df8fe26",
      "name": "Supply - stage (1.0.1)",
      "version": "1.0.1",
      "sourceEnvironment": "stage",
      "systemEnvironmentId": null,
      "status": "discovered",
      "endpointsCount": 6,
      "discoverySource": "api_gateway_app",
      "tags": [],
      "discoveredAt": "2026-02-12T04:01:26.000Z"
    },
    {
      "id": "0eab2aa4-d39b-49eb-a17b-d6c7b7eb9c9d",
      "name": "Order - stage (3.0.0)",
      "version": "3.0.0",
      "sourceEnvironment": "stage",
      "systemEnvironmentId": null,
      "status": "discovered",
      "endpointsCount": 2,
      "discoverySource": "api_gateway_app",
      "tags": [],
      "discoveredAt": "2026-02-12T04:01:26.000Z"
    },
    {
      "id": "a6aa80f3-bc34-4314-abc4-22c4fc5fd15d",
      "name": "Jelly Bean Wiki (IBM - 9) - sandbox (1.0.0)",
      "version": "1.0.0",
      "sourceEnvironment": "sandbox",
      "systemEnvironmentId": null,
      "status": "discovered",
      "endpointsCount": 3,
      "discoverySource": "api_gateway_app",
      "tags": [],
      "discoveredAt": "2026-02-12T04:01:26.000Z"
    },
    {
      "id": "5f5bda12-63e2-47d2-8824-ed5889de571a",
      "name": "Jelly Bean Wiki (IBM - 8) - sandbox (1.0.0)",
      "version": "1.0.0",
      "sourceEnvironment": "sandbox",
      "systemEnvironmentId": null,
      "status": "discovered",
      "endpointsCount": 3,
      "discoverySource": "api_gateway_app",
      "tags": [],
      "discoveredAt": "2026-02-12T04:01:26.000Z"
    },
    {
      "id": "339f3be5-0a91-47d5-a8c3-90d644752f5e",
      "name": "Jelly Bean Wiki (IBM - 7) - sandbox (1.0.0)",
      "version": "1.0.0",
      "sourceEnvironment": null,
      "systemEnvironmentId": null,
      "status": "discovered",
      "endpointsCount": 3,
      "discoverySource": "api_gateway_app",
      "tags": [],
      "discoveredAt": "2026-02-12T04:01:26.000Z"
    }
  ]
}
```

**SDK Code**

```python Successful Response
import requests

url = "https://api.postman.com/api-catalog/discovery-services"

headers = {"x-api-key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Successful Response
const url = 'https://api.postman.com/api-catalog/discovery-services';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Successful Response
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.postman.com/api-catalog/discovery-services"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Successful Response
require 'uri'
require 'net/http'

url = URI("https://api.postman.com/api-catalog/discovery-services")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java Successful Response
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.postman.com/api-catalog/discovery-services")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php Successful Response
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.postman.com/api-catalog/discovery-services', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Successful Response
using RestSharp;

var client = new RestClient("https://api.postman.com/api-catalog/discovery-services");
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift Successful Response
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.postman.com/api-catalog/discovery-services")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### No Results Found

**Response**

```json
{
  "meta": {
    "total": 0,
    "nextCursor": null
  },
  "data": []
}
```

**SDK Code**

```python No Results Found
import requests

url = "https://api.postman.com/api-catalog/discovery-services"

headers = {"x-api-key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript No Results Found
const url = 'https://api.postman.com/api-catalog/discovery-services';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go No Results Found
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.postman.com/api-catalog/discovery-services"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby No Results Found
require 'uri'
require 'net/http'

url = URI("https://api.postman.com/api-catalog/discovery-services")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java No Results Found
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.postman.com/api-catalog/discovery-services")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php No Results Found
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.postman.com/api-catalog/discovery-services', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp No Results Found
using RestSharp;

var client = new RestClient("https://api.postman.com/api-catalog/discovery-services");
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift No Results Found
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.postman.com/api-catalog/discovery-services")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```