API Reference
Services
Runframe V1 services API. List services, discover service keys, and look up service details.
Discover and look up services for use in incident creation and routing.
If you need to resolve a person or team name before filtering incidents, see Users and GET /api/v1/teams?search=....
List Services
GET /api/v1/servicesThis is how clients discover service keys for use in service_ids when creating incidents.
| Parameter | Type | Description |
|---|---|---|
limit | integer | Results per page (max 100, default 20) |
offset | integer | Pagination offset (default 0) |
search | string | Filter by name |
Response:
{
"success": true,
"data": {
"items": [
{
"id": "uuid",
"name": "API Gateway",
"service_key": "SER-00001",
"description": "Main API gateway service",
"is_active": true
}
],
"total": 10,
"has_more": false,
"next_offset": null
}
}Pagination uses true limit + offset semantics. offset=35&limit=10 returns items 36-45.
Get Service
GET /api/v1/services/:idLook up a service by UUID.
service_key lookup is not supported in v1. Use List Services to browse and find the UUID for a specific service.
Response:
{
"success": true,
"data": {
"id": "uuid",
"name": "API Gateway",
"service_key": "SER-00001",
"description": "Main API gateway service",
"is_active": true
}
}Service Keys
service_key is the public, org-scoped service identifier used for routing:
- Format:
SER-00001,SER-00002, etc. - Used in
service_idswhen creating incidents - Discoverable via
GET /api/v1/services - Only active services are valid targets for incident creation