---
title: "Get reply scan metadata"
method: GET
path: "/reply-scans/{scan_id}"
tags: ["Messages"]
---

# Get reply scan metadata

`GET /reply-scans/{scan_id}`

## Request

- Base URL: `https://shipmail.to/api/v1`
- URL: `https://shipmail.to/api/v1/reply-scans/{scan_id}`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://shipmail.to/api/auth/oauth2/authorize`, token URL `https://shipmail.to/api/auth/oauth2/token`)

## Headers

- `X-Shipmail-Organization` string

## Response `200`

Reply scan status.

- ReplyScan
  - `object` 'reply_scan', required
  - `id` string, required
  - `mailbox_ids` string[], required
  - `after` string, date-time, required
  - `before` string, date-time, required
  - `snapshot_at` string, date-time, required
  - `status` 'completed', required
  - `candidate_count` integer, required
  - `completed_at` string, date-time, required
  - `created_at` string, date-time, required

## Other responses

- `401`: Authentication failed.
- `403`: Insufficient permissions.
- `404`: Resource not found.
- `422`: Validation failed.
- `429`: Rate limit exceeded.

---

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