---
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
- `search` string, nullable
- `group_by` 'created_at' | 'name' | 'updated_at' | 'host' | 'network_id' | 'position' | 'service_definition' | 'last_seen_at' — Fields that services can be ordered/grouped by.
- `order_by` 'created_at' | 'name' | 'updated_at' | 'host' | 'network_id' | 'position' | 'service_definition' | 'last_seen_at' — Fields that services can be ordered/grouped by.
- `order_direction` 'asc' | 'desc' — Direction for ORDER BY clauses.
- `ports` integer[], nullable
- `exclude_categories` ServiceCategory[], nullable
- `limit` integer, nullable
- `offset` integer, nullable
- `at` string, date-time, nullable
- `stale` boolean, nullable

## Response `200`

List of services

- PaginatedApiResponseService — Response type for paginated list endpoints (pagination is always present in meta)
  - `data` object[], required — The page of results. Empty when nothing matched the query.
    - `bindings` Binding[], required — Ports and IP addresses this service is reachable on.
      - union
        - object — Association between a service and a port / interface that the service is listening on
          - `ip_address_id` string, uuid, required — The IP address the service is present at.
          - `type` 'IPAddress', required
          - `network_id` string, uuid, required — The network this entity belongs to.
          - `service_id` string, uuid, required — The service this entity refers to.
          - `created_at` string, date-time, required — When this record was first created.
          - `first_discovery_id` string, uuid, nullable — The discovery that first observed this entity.
          - `id` string, uuid, required — Server-assigned unique identifier.
          - `last_discovery_id` string, uuid, nullable — The most recent discovery that observed this entity.
          - `last_seen_at` string, date-time — When a discovery last observed this entity.
          - `lineage_id` string, uuid, nullable — Stable identifier shared by every revision of the same entity across its history.
          - `updated_at` string, date-time, required — When this record was last modified.
          - `valid_from` string, date-time — Start of the interval this revision was current for (SCD2 history).
          - `valid_to` string, date-time, nullable — End of the interval this revision was current for. `null` while it is the live revision.
        - 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 — The port the service listens on.
          - `type` 'Port', required
          - `network_id` string, uuid, required — The network this entity belongs to.
          - `service_id` string, uuid, required — The service this entity refers to.
          - `created_at` string, date-time, required — When this record was first created.
          - `first_discovery_id` string, uuid, nullable — The discovery that first observed this entity.
          - `id` string, uuid, required — Server-assigned unique identifier.
          - `last_discovery_id` string, uuid, nullable — The most recent discovery that observed this entity.
          - `last_seen_at` string, date-time — When a discovery last observed this entity.
          - `lineage_id` string, uuid, nullable — Stable identifier shared by every revision of the same entity across its history.
          - `updated_at` string, date-time, required — When this record was last modified.
          - `valid_from` string, date-time — Start of the interval this revision was current for (SCD2 history).
          - `valid_to` string, date-time, nullable — End of the interval this revision was current for. `null` while it is the live revision.
    - `host_id` string, uuid, required — The host this entity belongs to.
    - `name` string, required — Human-facing name for the service.
    - `network_id` string, uuid, required — The network this entity belongs to.
    - `position` integer, required — Position of this service in the host's service list (for ordering)
    - `service_definition` string, required — Which known software this service is, if identified.
    - `source` union, required
      - object
        - `type` 'Manual', required
      - object
        - `type` 'System', required
      - 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
              - …
        - `type` 'DiscoveryWithMatch', required
      - object
        - `type` 'Unknown', required
    - `tags` string[], required — Tags assigned to this entity.
    - `virtualization_metadata` union
      - object
        - `details` DockerVirtualization, required
          - `compose_project` string, nullable — Compose project the container belongs to, when it was started by Compose.
          - `container_id` string, nullable — Docker container ID.
          - `container_name` string, nullable — Container name as reported by Docker.
        - `type` 'Docker', required
      - object
        - `details` PodmanVirtualization, required
          - `compose_project` string, nullable — Compose project the container belongs to, when it was started by Compose.
          - `container_id` string, nullable — Podman container ID.
          - `container_name` string, nullable — Container name as reported by Podman.
        - `type` 'Podman', required
    - `virtualization_service_id` string, uuid, nullable, required — The container runtime service hosting this container — see the note on `HostBase::virtualization_service_id`.
    - `created_at` string, date-time, required — When this record was first created.
    - `first_discovery_id` string, uuid, nullable — The discovery that first observed this entity.
    - `id` string, uuid, required — Server-assigned unique identifier.
    - `last_discovery_id` string, uuid, nullable — The most recent discovery that observed this entity.
    - `last_seen_at` string, date-time — When a discovery last observed this entity.
    - `lineage_id` string, uuid, nullable — Stable identifier shared by every revision of the same entity across its history.
    - `updated_at` string, date-time, required — When this record was last modified.
    - `valid_from` string, date-time — Start of the interval this revision was current for (SCD2 history).
    - `valid_to` string, date-time, nullable — End of the interval this revision was current for. `null` while it is the live revision.
  - `error` string, nullable — Human-readable failure message. Omitted on success.
  - `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.
      - `group_counts` GroupCount[], nullable — Size of every group, in the same order the rows are grouped, when the request specified a `group_by`. Lets a paginated client show a group's true size instead of the slice of it that happens to be on this page. Absent when the list isn't grouped.
        - `count` integer, required — How many rows fall in this group in total, not just on this page.
        - `value` string, nullable — The group's value, rendered as text. `null` for rows whose group key is NULL (the "ungrouped" bucket).
      - `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 — `true` when the request succeeded. `false` responses carry `error` instead of `data`.

---

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