---
title: "List all services"
method: GET
path: "/api/v1/services"
tags: ["Services"]
---

# List all services

`GET /api/v1/services`

Returns all services the authenticated user has access to.
Supports pagination via `limit` and `offset` query parameters,
and ordering via `group_by`, `order_by`, and `order_direction`.

## Query parameters

- `network_id` string, uuid, nullable
- `host_id` string, uuid, nullable
- `ids` string[], nullable
- `tag_ids` string[], nullable
- `group_by` 'created_at' | 'name' | 'updated_at' | 'host' | 'network_id' | 'position' — Fields that services can be ordered/grouped by.
- `order_by` 'created_at' | 'name' | 'updated_at' | 'host' | 'network_id' | 'position' — Fields that services can be ordered/grouped by.
- `order_direction` 'asc' | 'desc' — Direction for ORDER BY clauses.
- `exclude_categories` ServiceCategory[], nullable
- `limit` integer, nullable
- `offset` integer, nullable

## Response `200`

List of services

- PaginatedApiResponseService — Response type for paginated list endpoints (pagination is always present in meta)
  - `data` object[], required
    - `bindings` Binding[], required
      - union
        - object — Association between a service and a port / interface that the service is listening on
          - `ip_address_id` string, uuid, required
          - `type` 'IPAddress', required
          - `network_id` string, uuid, required
          - `service_id` string, uuid, required
          - `created_at` string, date-time, required
          - `id` string, uuid, required
          - `updated_at` string, date-time, required
        - object — Association between a service and a port / interface that the service is listening on
          - `ip_address_id` string, uuid, nullable, required — The IP address this port binding applies to. If `null`, the binding applies to all IP addresses on the host (and supersedes specific-IP-address bindings for this port).
          - `port_id` string, uuid, required
          - `type` 'Port', required
          - `network_id` string, uuid, required
          - `service_id` string, uuid, required
          - `created_at` string, date-time, required
          - `id` string, uuid, required
          - `updated_at` string, date-time, required
    - `host_id` string, uuid, required
    - `name` string, required
    - `network_id` string, uuid, required
    - `position` integer, required — Position of this service in the host's service list (for ordering)
    - `service_definition` string, required
    - `source` union, required
      - object
        - `type` 'Manual', required
      - object
        - `type` 'System', required
      - object
        - `metadata` DiscoveryMetadata[], required
          - union
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
        - `type` 'Discovery', required
      - object
        - `details` MatchDetails, required
          - `confidence` 'NotApplicable' | 'Low' | 'Medium' | 'High' | 'Certain', required
          - `reason` union, required — Match reason - either a simple reason string or a container with nested reasons
            - object
              - …
            - object
              - …
        - `metadata` DiscoveryMetadata[], required
          - union
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
        - `type` 'DiscoveryWithMatch', required
      - object
        - `type` 'Unknown', required
    - `tags` string[], required
    - `virtualization` ServiceVirtualization
      - `details` DockerVirtualization, required
        - `compose_project` string, nullable
        - `container_id` string, nullable
        - `container_name` string, nullable
        - `service_id` string, uuid, required
      - `type` 'Docker', required
    - `created_at` string, date-time, required
    - `id` string, uuid, required
    - `updated_at` string, date-time, required
  - `error` string, nullable
  - `meta` PaginatedApiMeta, required — API metadata for paginated list responses (pagination is always present)
    - `api_version` integer, required — API version (integer, increments on breaking changes)
    - `pagination` PaginationMeta, required — Pagination metadata returned with paginated responses.
      - `has_more` boolean, required — Whether there are more items after this page
      - `limit` integer, required — Maximum items per page (as requested)
      - `offset` integer, required — Number of items skipped
      - `total_count` integer, required — Total number of items matching the filter (ignoring pagination)
    - `server_version` string, required — Server version (semver)
  - `success` boolean, required

## Changes

- **2026-04-20** `f04499e2280f` — 1 breaking, 13 warning, 3 info
  - removed the enum value `Integration` from the property `items/` of the `query` request parameter `exclude_categories`
  - deleted the `query` request parameter `at`
  - removed the optional property `data/items/allOf[#/components/schemas/ServiceBase]/bindings/items/allOf[subschema #2]/first_discovery_id` from the response with the `200` status
  - removed the optional property `data/items/allOf[#/components/schemas/ServiceBase]/bindings/items/allOf[subschema #2]/last_discovery_id` from the response with the `200` status
  - …13 more

[Change history](https://skmtc.dev/scanopy/apis/scanopy-api/changes/api/v1/services/get.md)

---

[API](https://skmtc.dev/scanopy/apis/scanopy-api.md) · [All operations](https://skmtc.dev/scanopy/apis/scanopy-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/scanopy/scanopy-api/revisions/f04499e2280f/schema)