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

# Service List

`GET /api/v1/services/`

List the existing services

## Query parameters

- `page` integer, nullable — The page number from which to start (0-based)
- `limit` integer — The maximum number of items to return
- `search_fields` ServiceProperties[] — String names of fields to search. Correspond by index to search field values
- `search_field_values` string[] — Values of fields to search. Correspond by index to search fields. Unless field name contains "list", an individual search field value cannot be a list
- `order_by` 'id' | 'name' | 'description' | 'last_updated' | 'last_updated_by' — Names of service fields supported for filtering/sorting on list endpoint.
- `order_by_direction` 'asc' | 'desc' — The direction in which to order list results, either ascending or descending.
- `fields` ServiceProperties[], nullable — The fields to include in the response
- `start_datetime` string, nullable — The start datetime for filtering results
- `end_datetime` string, nullable — The end datetime for filtering results

## Response `200`

Successful Response

- ListResponseServiceResponse
  - `items` ServiceResponse[], required — List of items returned from the query
    - `id` integer, required — The internal ID of the service
    - `name` string, required — The name of the service
    - `description` string, required — The description of the service
    - `auth_type` 'basic' | 'bearer' | 'custom_headers' | 'oauth2'
    - `auth_value_keys` string[], nullable — Auth value keys (values omitted for security)
    - `last_updated_comments` string, nullable — Free text providing comment about what was updated
    - `last_updated` string, date-time, required — The timestamp of the most recent update to the service
    - `last_updated_by` string, required — The email of the user who last updated the service
    - `tools` string[], required — Names of tools that belong to the service
  - `page` integer, required — The page number of the results (0-based)
  - `page_size` integer, required — The number of items returned per page
  - `total_pages` integer, nullable — The total number of pages of results given the indicated page size
  - `total_count` integer, nullable — The total number of items returned from the query

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/asksyllable/apis/syllablesdk.md) · [All operations](https://skmtc.net/asksyllable/apis/syllablesdk/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/asksyllable/syllablesdk/versions/ac3228f980bb/schema)