---
title: "Get tool versions"
method: GET
path: "/v1/{organization}/tool/{tool_id}/version"
tags: ["Tool"]
---

# Get tool versions

`GET /v1/{organization}/tool/{tool_id}/version`

## Path parameters

- `organization` string, required
- `tool_id` string, required — The ID of the tool to retrieve versions for.

## Query parameters

- `deprecated` boolean, nullable — Whether to filter by deprecated tool versions.
- `versions` string, nullable — A semver constraint that specifies the versions to retrieve.
- `sort_by` string[] — The fields to sort the versions by. Supported fields are `created_at`, `version.major`, `version.minor`, `version.patch`, and `deprecated`. Specify a `+` before the field name to indicate ascending sorting and `-` for descending sorting. Multiple fields can be specified to break ties.
- `creator` string[] — The creators of the tool versions. Each value must be of the format `org_id,user_id`.
- `limit` integer — The maximum number of tool versions to return.
- `continuation_token` integer — The continuation token from the previous request used to retrieve the next page of tool versions.

## 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.

- SrcAppEndpointsToolGetToolVersionsResponse
  - `tool_versions` ToolVersionInstance[], required — A list of tool versions that are found.
    - `id` string, required — The identifier of the tool version.
    - `org_id` string, required — The ID of the organization.
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `tool_id` string, required — The ID of the tool that this version belongs to.
    - `version` Version, required
      - `major` integer, required
      - `minor` integer, required
      - `patch` integer, required
    - `required_envvars` string[], required — The environment variables that are required to run the tool.
    - `required_secret_envvars` string[], required — The secret environment variables that are required to run the tool.
    - `input_schema` object, required — The input schema of the tool.
    - `tool_commit_hash` string, required — The commit hash of the tool within the repository.
    - `amigo_scaffold_commit_hash` string, required — The commit hash of the Amigo scaffold that this tool version was created with.
    - `project_directory` string, required — The project directory of the tool.
    - `lambda_version` integer, required — The version of the Lambda function that corresponds to this tool version.
    - `creator` AmigoLibMongoCollectionsToolVersionToolVersionUserInfo, required
      - `user_id` string, required — The ID of the user.
      - `user_org_id` string, required — The ID of the user's organization.
    - `updated_by` AmigoLibMongoCollectionsToolVersionToolVersionUserInfo, required
      - `user_id` string, required — The ID of the user.
      - `user_org_id` string, required — The ID of the user's organization.
    - `deprecated` boolean, required — Whether the tool version is deprecated. Deprecated tool versions are not usable and do not participate in version resolution.
  - `has_more` boolean, required — Whether there are more tool versions to retrieve.
  - `continuation_token` unknown, required
  - `filter_values` SrcAppEndpointsToolGetToolVersionsResponseFilterValues, required
    - `creators` AmigoLibMongoCollectionsToolVersionToolVersionUserInfo[], required — The list of users who created the simulation personas.
      - `user_id` string, required — The ID of the user.
      - `user_org_id` string, required — The ID of the user's organization.

## Other responses

- `401` — Invalid authorization credentials.
- `403` — Missing required permissions.
- `404` — Specified organization or tool is not found.
- `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)