Get a service by ID

GET

/api-catalog/services/:serviceId

GET

/api-catalog/services/:serviceId

$ curl -G https://api.getpostman.com/api-catalog/services/c6ec74e7-14f8-498c-9470-7a654173bed6 \
>      -H "x-api-key: <apiKey>" \
>      -d systemEnvironmentId=23b554c1-c30c-483d-bf98-dbe9ab7b88a0

1 {
2   "meta": {
3     "timeRange": {
4       "start": "2026-04-14T13:09:36.521Z",
5       "end": "2026-04-21T13:09:36.521Z",
6       "label": "last_7_days"
7     },
8     "filters": {}
9   },
10   "data": {
11     "id": "a5450abd-ec89-443c-a17a-68132e738714",
12     "name": "api-control-service",
13     "status": "critical",
14     "lastActivityAt": "2026-04-21T13:09:33Z",
15     "traffic": {
16       "p95LatencyMs": 251.8122497558594,
17       "errorRatePct": 0.78,
18       "totalRequests": 10999,
19       "totalRequestsDeltaPct": 398.82,
20       "totalErrors": 86,
21       "totalEndpoints": 10,
22       "p95LatencyMsDeltaPct": 0.47,
23       "errorRatePctDeltaPct": 188.89
24     },
25     "compliance": {
26       "monitorRun": {
27         "status": "failed",
28         "totalMonitors": 3,
29         "activeMonitors": 3,
30         "passingMonitors": 1,
31         "failingMonitors": 2,
32         "lastRunAt": "2026-04-21T13:09:24.847Z"
33       },
34       "cliRun": {
35         "status": "failed",
36         "activePipelines": 5,
37         "passingPipelines": 3,
38         "failingPipelines": 2,
39         "lastRunAt": "2026-04-19T12:08:43.112Z"
40       },
41       "specLint": {
42         "status": "passed",
43         "totalSpecs": 2,
44         "activeSpecs": 1,
45         "passingSpecs": 1,
46         "failingSpecs": 0,
47         "lastRunAt": "2026-04-19T12:08:43.110Z"
48       },
49       "collectionRuns": {
50         "totalRuns": 3159,
51         "passedRuns": 462,
52         "failedRuns": 2697,
53         "passRate": 14.62,
54         "totalCollections": 2,
55         "activeCollections": 2,
56         "totalAssertions": 161456,
57         "failedAssertions": 69355
58       }
59     },
60     "entityCounts": {
61       "collections": 2,
62       "specifications": 2,
63       "monitors": 3,
64       "mocks": 0,
65       "flows": 0,
66       "environments": 2
67     },
68     "createdAt": "2025-12-04T15:13:31.000Z",
69     "gitRepo": "https://github.com/acs-team/api-control-service",
70     "owner": {
71       "type": "user",
72       "id": "12345678",
73       "name": "Taylor Lee",
74       "profilePicUrl": "https://res.cloudinary.com/ddn1d7iih/image/upload/t_user_profile_300/v1/user/default-9",
75       "publicHandle": "https://www.acs-beta.example.com/orbital-module-specialist-12345678"
76     },
77     "tags": [
78       "acs-beta",
79       "acs"
80     ],
81     "governanceGroup": {
82       "id": "4937d932-b1f4-44cd-a929-4a860707766e",
83       "name": "ACS"
84     },
85     "dependencies": [
86       {
87         "id": "svc_3l2QDWTQQ161UYpSwGK34U",
88         "name": "external",
89         "direction": "inbound"
90       },
91       {
92         "id": "svc_5izBBtWeFwxRhvtqJwfNU7",
93         "name": "Identity - Beta",
94         "direction": "inbound"
95       },
96       {
97         "id": "svc_5izBBtWeFwxRhvtqJwfNU7",
98         "name": "Identity - Beta",
99         "direction": "outbound"
100       }
101     ]
102   }
103 }

Gets information about a service, including its health, traffic, compliance, ownership, and dependencies.

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 service's ID.

Query parameters

systemEnvironmentIdstringRequired

The system environment's ID.

Response

Successful Response

metaobject

The response's meta information for paginated results.

dataobject

Information about the service.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error