---
title: "Get a suite"
method: GET
path: "/v1/suites/{suiteId}"
tags: ["Suites"]
---

# Get a suite

`GET /v1/suites/{suiteId}`

## Request

- Base URL: `https://api.ironfang.com/rig`
- URL: `https://api.ironfang.com/rig/v1/suites/{suiteId}`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

Returns the suite and its current version.

## Response `200`

The suite and its current version

- SuiteWithVersion
  - `suite` Suite, required
    - `archived_at` string, date-time
    - `created_at` string, date-time, required
    - `current_version` integer, required
    - `id` string, uuid, required
    - `name` string, required
    - `organisation_id` string, uuid, required
    - `project_id` string, uuid, required
    - `slug` string, required
  - `version` SuiteVersion, required
    - `created_at` string, date-time, required
    - `created_by` string
    - `definition` Definition, required: A suite's content. Resources are named identities a run receives; expectations are deterministic conditions on the run's events, stored and validated now and evaluated once the platform observes the events they name.
      - `defaults` object
        - `run_ttl` string: Default run lifetime, 1m to 24h ("30m").
      - `expectations` ExpectationSpec[]
        - `event` string, required: An event type from the catalogue, such as email.received or callback.forwarded.
        - `id` string, required
        - `match` object
        - `resource` string, required: A declared resource name.
      - `resources` object, required
      - `version` 1, required
    - `definition_sha256` string, required: SHA-256 of the canonical definition.
    - `id` string, uuid, required
    - `organisation_id` string, uuid, required
    - `suite_id` string, uuid, required
    - `version` integer, required

## Other responses

- `401`: No credential, an invalid one, or a delegated token where none is accepted (`unauthorized`, `invalid_api_key`, `delegated_not_allowed`).
- `403`: The credential lacks the permission or scope, or names another organisation (`forbidden`, `insufficient_scope`).
- `404`: No such object in this organisation (`not_found`).

---

[API](https://skmtc.dev/ironfang/apis/ironfang-rig-api.md) · [All operations](https://skmtc.dev/ironfang/apis/ironfang-rig-api/llms.txt) · [OpenAPI document](https://skmtc.dev/ironfang/apis/ironfang-rig-api/revisions/3e86a312dad1?raw)