Get all services

GET

/api-catalog/services

GET

/api-catalog/services

$ curl -G https://api.getpostman.com/api-catalog/services \
>      -H "x-api-key: <apiKey>" \
>      -d systemEnvironmentId=23b554c1-c30c-483d-bf98-dbe9ab7b88a0

1 {
2   "meta": {
3     "nextCursor": null,
4     "limit": 20,
5     "filters": {
6       "systemEnvironmentId": "23b554c1-c30c-483d-bf98-dbe9ab7b88a0"
7     },
8     "timeRange": {
9       "start": "2026-04-14T12:36:15.339Z",
10       "end": "2026-04-21T12:36:15.339Z",
11       "label": "last_7_days"
12     }
13   },
14   "data": [
15     {
16       "id": "a5450abd-ec89-443c-a17a-68132e738714",
17       "name": "api-control-service",
18       "status": "critical",
19       "lastActivityAt": "2026-04-21T12:36:00Z",
20       "traffic": {
21         "p95LatencyMs": 251.8122497558594,
22         "errorRatePct": 0.78
23       },
24       "compliance": {
25         "monitorRun": {
26           "status": "failed"
27         },
28         "cliRun": {
29           "status": "failed"
30         },
31         "specLint": {
32           "status": "passed"
33         }
34       },
35       "createdAt": "2025-12-04T15:13:31.000Z",
36       "gitRepo": "https://github.com/acs-team/api-control-service",
37       "owner": {
38         "type": "user",
39         "id": "12345678",
40         "name": "Taylor Lee",
41         "profilePicUrl": "https://res.cloudinary.com/ddn1d7iih/image/upload/t_user_profile_300/v1/user/default-9",
42         "publicHandle": "https://www.acs-beta.example.com/orbital-module-specialist-12345678"
43       },
44       "tags": [
45         "develop",
46         "acs",
47         "beta"
48       ],
49       "governanceGroup": {
50         "id": "4937d932-b1f4-44cd-a929-4a860707766e",
51         "name": "ACS"
52       }
53     },
54     {
55       "id": "47d1b387-2485-482a-bf62-46ddd70a6d1e",
56       "name": "API observability",
57       "status": "healthy",
58       "lastActivityAt": "2026-04-21T07:00:33Z",
59       "traffic": {
60         "p95LatencyMs": 104.64400291442871,
61         "errorRatePct": 0
62       },
63       "compliance": {
64         "monitorRun": {
65           "status": "passed"
66         },
67         "cliRun": {
68           "status": "failed"
69         },
70         "specLint": {
71           "status": "failed"
72         }
73       },
74       "createdAt": "2024-03-06T20:08:45.000Z",
75       "gitRepo": "https://github.com/acs-team/observability-service",
76       "owner": {
77         "type": "user",
78         "id": "12345678",
79         "name": "Taylor Lee",
80         "profilePicUrl": "https://res.cloudinary.com/ddn1d7iih/image/upload/t_user_profile_300/v1/user/default-9",
81         "publicHandle": "https://www.acs-beta.example.com/orbital-module-specialist-12345678"
82       },
83       "tags": [],
84       "governanceGroup": null
85     },
86     {
87       "id": "602af26e-958b-471b-b35a-1d5ff9e8e510",
88       "name": "identity-service",
89       "status": "inactive",
90       "lastActivityAt": null,
91       "traffic": {
92         "p95LatencyMs": 1175.7943176269537,
93         "errorRatePct": 36.8
94       },
95       "compliance": {
96         "monitorRun": {
97           "status": "failed"
98         },
99         "cliRun": {
100           "status": "failed"
101         },
102         "specLint": {
103           "status": "failed"
104         }
105       },
106       "createdAt": "2025-12-03T10:46:54.000Z",
107       "gitRepo": "https://github.com/acs-team/monitor-service",
108       "owner": {
109         "type": "user",
110         "id": "12345678",
111         "name": "Taylor Lee",
112         "profilePicUrl": "https://res.cloudinary.com/ddn1d7iih/image/upload/t_user_profile_300/v1/user/default-9",
113         "publicHandle": "https://www.acs-beta.example.com/orbital-module-specialist-12345678"
114       },
115       "tags": [
116         "develop",
117         "acs",
118         "beta"
119       ],
120       "governanceGroup": {
121         "id": "4937d932-b1f4-44cd-a929-4a860707766e",
122         "name": "ACS"
123       }
124     }
125   ]
126 }

Gets a list of services in a system environment. The response includes details about analytics, compliance, and governance metadata.

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

systemEnvironmentIdstringRequired

The system environment's ID.

namestringOptional<=255 characters

Filter results to the given the service name. This is case-insensitive.

tagsstringOptionalformat: "^[^,]+(,[^,]+)*$"

A comma-separated list of tag names to filter by.

governanceGroupIdstringOptional

Filter results to only services that belong to the given governance group ID.

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 list of services.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error