---
title: "Retrieve the remediation workflow"
method: GET
path: "/v1/remediation-workflow"
tags: ["Internal Secret Incidents"]
---

# Retrieve the remediation workflow

`GET /v1/remediation-workflow`

Retrieve the remediation workflow displayed for secret incidents.

Returns the custom remediation workflow configured for the account when one
exists and is active, otherwise a default workflow. For the default workflow,
`id`, `gg_created_at` and `gg_updated_at` are omitted.

## Response `200`

Remediation Workflow

- object — The remediation workflow displayed for secret incidents. Returns the custom workflow configured for the account when one exists, otherwise a default workflow. For the default workflow, `id`, `created_at` and `updated_at` are omitted.
  - `id` integer — Identifier of the workflow. Absent for the default workflow.
  - `account_id` integer, required — Identifier of the account owning the workflow.
  - `steps` object[], required — Ordered list of remediation steps.
    - `title` string, required — Title of the remediation step.
    - `description` string — Detailed explanation of the remediation step.
    - `link` object, nullable — Optional link associated with the step.
      - `text` string, nullable — Display text for the link.
      - `url` string — URL of the link.
  - `created_at` string, date-time — Creation date. Absent for the default workflow.
  - `updated_at` string, date-time — Last update date. Absent for the default workflow.

## Other responses

- `401` — Invalid API key
- `503` — API under maintenance

---

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