> 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 all services GET https://api.postman.com/api-catalog/services Gets a list of services in a system environment. The response includes details about analytics, compliance, and governance metadata. Reference: https://learning.postman.com/api-docs/api-reference/api-catalog/get-api-catalog-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 - `systemEnvironmentId` (string, required) — The system environment's ID. - `name` (string, optional) — Filter results to the given the service name. This is case-insensitive. - `tags` (string, optional) — A comma-separated list of tag names to filter by. - `governanceGroupId` (string, optional) — Filter results to only services that belong to the given governance group ID. - `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. - `nextCursor` (string, required) — The pagination cursor that points to the next record in the results set. - `limit` (integer, required) — The maximum number of records in the paginated response. - `filters` (object, required) — The filters applied to the request. - `timeRange` (object, required) — The time window for the returned data. - `start` (datetime, required) — The start of the time window. - `end` (datetime, required) — The end of the time window. - `label` (enum, required) — The time range's label. - Allowed values: `last_7_days` - `data` (list of object, optional) — A list of list of services. - `id` (string, required) — The service's ID. - `name` (string, required) — The service's name. - `status` (enum, required) — The overall health status, derived from compliance signals. - Allowed values: `healthy`, `warning`, `critical`, `inactive` - `lastActivityAt` (datetime, required, nullable) — The date and time of the last observed activity. If there's no activity in the time window, this returns a null value. - `traffic` (object, required, nullable) — Information about traffic and performance within the time window. If there's no traffic data, this returns a null value. - `p95LatencyMs` (double, required, nullable) — The 95th-percentile response latency, in milliseconds. - `errorRatePct` (double, required, nullable) — The percentage of requests that resulted in errors. - `compliance` (object, required) — Information about compliance and governance. - `monitorRun` (object, required) — The scheduled monitor run summary. - `status` (enum, required, nullable) — Whether the monitor's latest runs passed or failed. If no runs exist, this returns a null value. - Allowed values: `passed`, `failed` - `cliRun` (object, required) — Information about the CI/CD pipeline. - `status` (enum, required, nullable) — Whether the pipelines' latest runs passed or failed. If no runs exist, this returns a null value. - Allowed values: `passed`, `failed` - `specLint` (object, required) — Information about the API specification lint. - `status` (enum, required, nullable) — Whether the specifications' latest lints passed or failed. If no lints exist, this returns a null value. - Allowed values: `passed`, `failed` - `createdAt` (datetime, required, nullable) — The date and time at which the workspace was created. - `gitRepo` (string, required, nullable) — The URL of the linked Git repository. If the workspace isn't connected to a repository, this returns a null value. - `owner` (object, required, nullable) — The service's owner. If no owner is assigned, this returns a null value. - `type` (enum, required) — The type of owner. - Allowed values: `user`, `group` - `id` (string, required) — The owner's ID. - `name` (string, required, nullable) — The owner's display name. - `profilePicUrl` (string, required, nullable) — The URL of the owner's profile picture. - `publicHandle` (string, required, nullable) — The URL of the owner's public profile. - `tags` (list of string, required) — A list of the workspace's tags. - `governanceGroup` (object, required, nullable) — The governance group that the workspace belongs to. If no governance group is assigned, this returns a null value. - `id` (string, required) — The governance group's ID. - `name` (string, required) — The governance group's name. ## Examples **Response** ```json { "meta": { "nextCursor": null, "limit": 20, "filters": { "systemEnvironmentId": "23b554c1-c30c-483d-bf98-dbe9ab7b88a0" }, "timeRange": { "start": "2026-04-14T12:36:15.339Z", "end": "2026-04-21T12:36:15.339Z", "label": "last_7_days" } }, "data": [ { "id": "a5450abd-ec89-443c-a17a-68132e738714", "name": "api-control-service", "status": "critical", "lastActivityAt": "2026-04-21T12:36:00Z", "traffic": { "p95LatencyMs": 251.8122497558594, "errorRatePct": 0.78 }, "compliance": { "monitorRun": { "status": "failed" }, "cliRun": { "status": "failed" }, "specLint": { "status": "passed" } }, "createdAt": "2025-12-04T15:13:31.000Z", "gitRepo": "https://github.com/acs-team/api-control-service", "owner": { "type": "user", "id": "12345678", "name": "Taylor Lee", "profilePicUrl": "https://res.cloudinary.com/ddn1d7iih/image/upload/t_user_profile_300/v1/user/default-9", "publicHandle": "https://www.acs-beta.example.com/orbital-module-specialist-12345678" }, "tags": [ "develop", "acs", "beta" ], "governanceGroup": { "id": "4937d932-b1f4-44cd-a929-4a860707766e", "name": "ACS" } }, { "id": "47d1b387-2485-482a-bf62-46ddd70a6d1e", "name": "API observability", "status": "healthy", "lastActivityAt": "2026-04-21T07:00:33Z", "traffic": { "p95LatencyMs": 104.64400291442871, "errorRatePct": 0 }, "compliance": { "monitorRun": { "status": "passed" }, "cliRun": { "status": "failed" }, "specLint": { "status": "failed" } }, "createdAt": "2024-03-06T20:08:45.000Z", "gitRepo": "https://github.com/acs-team/observability-service", "owner": { "type": "user", "id": "12345678", "name": "Taylor Lee", "profilePicUrl": "https://res.cloudinary.com/ddn1d7iih/image/upload/t_user_profile_300/v1/user/default-9", "publicHandle": "https://www.acs-beta.example.com/orbital-module-specialist-12345678" }, "tags": [], "governanceGroup": null }, { "id": "602af26e-958b-471b-b35a-1d5ff9e8e510", "name": "identity-service", "status": "inactive", "lastActivityAt": null, "traffic": { "p95LatencyMs": 1175.7943176269537, "errorRatePct": 36.8 }, "compliance": { "monitorRun": { "status": "failed" }, "cliRun": { "status": "failed" }, "specLint": { "status": "failed" } }, "createdAt": "2025-12-03T10:46:54.000Z", "gitRepo": "https://github.com/acs-team/monitor-service", "owner": { "type": "user", "id": "12345678", "name": "Taylor Lee", "profilePicUrl": "https://res.cloudinary.com/ddn1d7iih/image/upload/t_user_profile_300/v1/user/default-9", "publicHandle": "https://www.acs-beta.example.com/orbital-module-specialist-12345678" }, "tags": [ "develop", "acs", "beta" ], "governanceGroup": { "id": "4937d932-b1f4-44cd-a929-4a860707766e", "name": "ACS" } } ] } ``` **SDK Code** ```python Successful Response import requests url = "https://api.postman.com/api-catalog/services" querystring = {"systemEnvironmentId":"23b554c1-c30c-483d-bf98-dbe9ab7b88a0"} headers = {"x-api-key": ""} response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript Successful Response const url = 'https://api.postman.com/api-catalog/services?systemEnvironmentId=23b554c1-c30c-483d-bf98-dbe9ab7b88a0'; const options = {method: 'GET', headers: {'x-api-key': ''}}; 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/services?systemEnvironmentId=23b554c1-c30c-483d-bf98-dbe9ab7b88a0" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("x-api-key", "") 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/services?systemEnvironmentId=23b554c1-c30c-483d-bf98-dbe9ab7b88a0") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["x-api-key"] = '' response = http.request(request) puts response.read_body ``` ```java Successful Response import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.postman.com/api-catalog/services?systemEnvironmentId=23b554c1-c30c-483d-bf98-dbe9ab7b88a0") .header("x-api-key", "") .asString(); ``` ```php Successful Response request('GET', 'https://api.postman.com/api-catalog/services?systemEnvironmentId=23b554c1-c30c-483d-bf98-dbe9ab7b88a0', [ 'headers' => [ 'x-api-key' => '', ], ]); echo $response->getBody(); ``` ```csharp Successful Response using RestSharp; var client = new RestClient("https://api.postman.com/api-catalog/services?systemEnvironmentId=23b554c1-c30c-483d-bf98-dbe9ab7b88a0"); var request = new RestRequest(Method.GET); request.AddHeader("x-api-key", ""); IRestResponse response = client.Execute(request); ``` ```swift Successful Response import Foundation let headers = ["x-api-key": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://api.postman.com/api-catalog/services?systemEnvironmentId=23b554c1-c30c-483d-bf98-dbe9ab7b88a0")! 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() ```