---
title: "Read a test sink"
method: GET
path: "/v1/test-sinks/{sinkId}"
---

# Read a test sink

`GET /v1/test-sinks/{sinkId}`

## Request

- Base URL: `https://docs.greatwait.dev` (the document declares no server; this is the origin it was published from)
- URL: `https://docs.greatwait.dev/v1/test-sinks/{sinkId}`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer and API key in header `Greatwait-Environment` and API key in header `Greatwait-Project`

Reads one test sink from the caller's own project and test environment, including how many deliveries it has taken. A well-formed identifier belonging to another authority is indistinguishable from an absent sink.

## Path parameters

- `sinkId` string, required

## Response `200`

Read a test sink

- object
  - `createdAt` string, required
  - `deliveryCount` integer, required
  - `endpoint` string, required
  - `environmentKind` 'test', required
  - `id` string, required
  - `program` object, required
    - `behavior` 'client_error' | 'defer_abandon' | 'defer_fail' | 'defer_succeed' | 'delay' | 'disconnect' | 'duplicate' | 'invalid_signature' | 'rate_limited' | 'server_error' | 'success' | 'timeout', required
    - `completionDelayMs` integer
    - `delayMs` integer
    - `forDeliveries` integer
    - `retryAfterSeconds` integer
    - `status` integer
    - `then` 'client_error' | 'defer_abandon' | 'defer_fail' | 'defer_succeed' | 'delay' | 'disconnect' | 'duplicate' | 'invalid_signature' | 'rate_limited' | 'server_error' | 'success' | 'timeout'
  - `project` string, required
  - `updatedAt` string, required
  - `url` string, uri, required

## Other responses

- `400`: Problem document. Possible codes at this status: invalid_request.
- `401`: Problem document. Possible codes at this status: authentication_required, credential_expired, credential_revoked.
- `403`: Problem document. Possible codes at this status: scope_missing.
- `404`: Problem document. Possible codes at this status: not_found.
- `409`: Problem document. Possible codes at this status: project_archived, state_conflict.
- `429`: Problem document. Possible codes at this status: rate_limited.
- `503`: Problem document. Possible codes at this status: capability_not_configured, service_unavailable.

---

[API](https://skmtc.dev/greatwait/apis/greatwait-v1.md) · [All operations](https://skmtc.dev/greatwait/apis/greatwait-v1/llms.txt) · [OpenAPI document](https://skmtc.dev/greatwait/apis/greatwait-v1/revisions/6855bce23e72?raw)