---
title: "Get Swap Candidates"
method: GET
path: "/api/v1/steps/{step_id}/swap-candidates"
tags: ["steps"]
---

# Get Swap Candidates

`GET /api/v1/steps/{step_id}/swap-candidates`

## Path parameters

- `step_id` string, uuid, required

## Response `200`

Successful Response

- SwapCandidateList
  - `current_source` SwapCurrentSource, required
    - `id` string, uuid, nullable, required
    - `name` string, required
    - `type` 'database' | 'user_file', required
    - `columns` SwapColumn[], required
      - `name` string, required
      - `type` string
  - `candidates` SwapCandidate[], required
    - `id` string, uuid, required
    - `name` string, required
    - `type` 'database' | 'user_file', required
    - `owner_project_id` string, uuid, nullable, required
    - `owner_project_name` string, nullable, required
    - `is_shared` boolean, required
    - `similarity_score` number, required
    - `severity` 'compatible' | 'partial' | 'risky' | 'no_match', required
    - `diff` SwapColumnDiff, required
      - `matching` string[], required
      - `missing_in_candidate` string[], required
      - `extra_in_candidate` string[], required
      - `retyped` SwapRetyped[], required
        - `name` string, required
        - `current_type` string, required
        - `candidate_type` string, required

## Other responses

- `422` — Validation Error

---

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