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-Organizationstring

OAuth access tokens only. The organization ID this request acts on. Required when the OAuth connection was approved for several organizations (400 validation_error without it); optional with one. An organization the connection was not approved for returns 403 authorization_error. Ignored for API keys, which belong to one organization.

Response

Reply scan status.

object'reply_scan' required
idstring required
mailbox_idsstring[] required
afterstring date-time required
beforestring date-time required
snapshot_atstring date-time required
status'completed' required
candidate_countinteger required
completed_atstring date-time required
created_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.