---
title: "Get services"
method: GET
path: "/v1/{organization}/service/"
tags: ["Service"]
---

# Get services

`GET /v1/{organization}/service/`

Retrieve a list of services in this organization.

#### Permissions
This endpoint is impacted by the following permissions:
* Only services that the authenticated user has the `Service:GetService` permission for are returned.

## Path parameters

- `organization` string, required

## Query parameters

- `id` string[] — The IDs of the services to retrieve.
- `is_active` boolean, nullable — Whether the service is active.
- `sort_by` string[] — The fields to sort the services by. Supported fields are `name` and `is_active`. Specify a `+` before the field name to indicate ascending sorting and `-` for descending sorting. Multiple fields can be specified to break ties.
- `tags` string[] — The tags to filter the services by. Must be specified using the syntax `key:value`, which means to match all services with the given `key` and `value` pair among its tags. If `value` is `*`, it means the `value` does not matter. If `value` is empty, it matches against when the value is `None`.
- `limit` integer — The maximum number of services to return.
- `continuation_token` integer — The continuation token from the previous request used to retrieve the next page of services.

## Headers

- `x-mongo-cluster-name` string, nullable — The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.
- `Sec-WebSocket-Protocol` string[]

## Response `200`

Succeeded.

- SrcAppEndpointsServiceGetServicesResponse
  - `services` ServiceInstance[], required — The services that are found.
    - `id` string, required — The identifier of the service.
    - `name` string, required — The name of the service.
    - `version_sets` object, required — The available version sets of the service.
    - `description` string, required — A description of the service.
    - `is_active` boolean, required — Whether the service is active.
    - `service_hierarchical_state_machine_id` string, required — The ID of the state machine that this service uses.
    - `agent_id` string, required — The ID of the agent that this service uses.
    - `tags` Tag[], required — The tags of the service.
      - `key` string, required
      - `value` string, nullable, required
    - `keyterms` string[], required — A list of keyterms that are easy to get wrong during audio transcriptions that tend to occur commonly in audio sessions using this service.
    - `creator` AmigoLibMongoCollectionsServiceServiceUserInfo, required
      - `org_id` string, required
      - `user_id` string, required
    - `updated_by` AmigoLibMongoCollectionsServiceServiceUserInfo, required
      - `org_id` string, required
      - `user_id` string, required
  - `has_more` boolean, required — Whether there are more services to retrieve.
  - `continuation_token` integer, nullable, required — A token to supply to the next request to retrieve the next page of services. Only populated if `has_more` is `True`.
  - `filter_values` SrcAppEndpointsServiceGetServicesResponseFilterValues, required
    - `tags` string[], required — A list of tags of the services.

## Other responses

- `401` — Invalid authorization credentials.
- `403` — Missing required permissions.
- `404` — The specified organization does not exist.
- `422` — Invalid request path parameter or request query parameter failed validation.
- `429` — The user has exceeded the rate limit of 50 requests per minute for this endpoint.
- `503` — The service is going through temporary maintenance.

---

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