---
title: "Get a stream with schema, sources, mapping status and routes"
method: GET
path: "/v1/streams/{streamId}"
tags: ["streams"]
---

# Get a stream with schema, sources, mapping status and routes

`GET /v1/streams/{streamId}`

## Request

- Base URL: `https://postbag.dev`
- URL: `https://postbag.dev/v1/streams/{streamId}`
- Auth: HTTP bearer

## Path parameters

- `streamId` string, required

## Response `200`

ok

- StreamDetail
  - `id` string, required
  - `slug` string, required
  - `name` string, required
  - `current_schema_version` integer, nullable, required
  - `counts` object, required
    - `sources` integer, required
    - `routes` integer, required
    - `submissions_30d` integer, required
  - `created_at` string, required
  - `schema` SchemaVersion
    - `json_schema` object, required
    - `ui` object
    - `changelog` string
    - `version` integer
    - `inferred` boolean
    - `created_at` string
    - `created_by` string
  - `sources` StreamSource[]
    - `id` string, required
    - `form_id` string
    - `selector` string
    - `mapping` object
    - `mapping_status` 'valid' | 'incomplete'
    - `missing` string[]
    - `stream_schema_version` integer
  - `routes` Route[]
    - `id` string, required
    - `form_id` string, nullable, required
    - `stream_id` string, nullable, required
    - `destination_id` string, required
    - `enabled` boolean, required
    - `mode` object, required
    - `window` object
    - `quality` object
    - `filter` string, nullable
    - `transform` string, nullable
    - `counts` object
    - `created_at` string
  - `form_template` SchemaVersion
    - `json_schema` object, required
    - `ui` object
    - `changelog` string
    - `version` integer
    - `inferred` boolean
    - `created_at` string
    - `created_by` string

## Other responses

- `400`: Error
- `401`: Error
- `403`: Error
- `404`: Not found
- `409`: Error
- `422`: Error

---

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