Path parameters

• identifier string Required

  The identifier parameter

Responses

• 200 application/json

  Successful response

  Hide response attributes Show response attributes object

  • user_id string
  • shrimp string

    Default value is empty.

  • record object Required
    Hide record attributes Show record attributes object

    • identifier string Required
    • created number Required
    • updated number Required
    • key string | null
    • shortid string Required
    • state string Required

      Values are new, shared, revealed, burned, previewed, expired, or orphaned.

    • custid string | null
    • owner_id string | null
    • shared string | null
    • previewed string | null
    • revealed string | null
    • burned string | null
    • secret_ttl string | null
    • receipt_ttl string | null
    • lifespan string | null
    • secret_shortid string | null
    • secret_identifier string | null

    • recipients array[string] | null | string

      Any of:

      array-1 array[string] | null string-2 string | null
    • recipient_name string | null
    • share_domain string | null
    • has_passphrase boolean | null
    • is_previewed string | null
    • is_revealed string | null
    • is_burned string | null
    • is_destroyed string | null
    • is_expired string | null
    • is_orphaned string | null
    • memo string | null

    • kind string | null

      Any of:

      string-1 string | null string-2 string | null

      Values are generate or conceal.

      Value is .

    • source string | null

      Values are standard or incoming.

    • received string | null
    • viewed string | null
    • is_viewed string | null
    • is_received string | null
    • secret_state string | null

      Values are new, shared, revealed, burned, previewed, expired, or orphaned.

    • natural_expiration string Required
    • expiration_in_seconds string | null
    • share_path string | null
    • burn_path string Required
    • receipt_path string Required
    • share_url string | null
    • receipt_url string Required
    • burn_url string Required
    • expiration number | null
  • details object
    Hide details attributes Show details attributes object

    • type string Required

      Value is record.

    • display_lines string | null
    • no_cache string | null
    • secret_realttl number | null
    • view_count string | null
    • first_access string | null
    • last_access string | null
    • has_passphrase string | null
    • can_decrypt string | null
    • secret_value string | null
    • show_secret string | null
    • show_secret_link string | null
    • show_receipt_link string | null
    • show_receipt string | null
    • show_recipients string | null
    • is_orphaned string | null
    • is_expired string | null
• 401 application/json

  Unauthorized - Authentication required

  Hide response attributes Show response attributes object

  • error string

    ADR-013: user-facing message (V2+). On frozen V1 this is the error type identifier.

  • error_type string

    Machine-readable error class the client branches on (ADR-013, e.g., "RecordNotFound")

  • message string

    Human-readable error message (legacy/V1 shape)

  • field string

    Field that caused the error, if applicable

  • error_id string

    Unique error tracking identifier

  • request_id string

    Request correlation id; mirrors the x-request-id response header and appears in the server request log. Quote this when reporting an error.

• 403 application/json

  Forbidden - Insufficient permissions

  Hide response attributes Show response attributes object

  • error string

    ADR-013: user-facing message (V2+). On frozen V1 this is the error type identifier.

  • error_type string

    Machine-readable error class the client branches on (ADR-013, e.g., "RecordNotFound")

  • message string

    Human-readable error message (legacy/V1 shape)

  • field string

    Field that caused the error, if applicable

  • error_id string

    Unique error tracking identifier

  • request_id string

    Request correlation id; mirrors the x-request-id response header and appears in the server request log. Quote this when reporting an error.

• 404 application/json

  Not Found - Resource does not exist

  Hide response attributes Show response attributes object

  • error string

    ADR-013: user-facing message (V2+). On frozen V1 this is the error type identifier.

  • error_type string

    Machine-readable error class the client branches on (ADR-013, e.g., "RecordNotFound")

  • message string

    Human-readable error message (legacy/V1 shape)

  • field string

    Field that caused the error, if applicable

  • error_id string

    Unique error tracking identifier

  • request_id string

    Request correlation id; mirrors the x-request-id response header and appears in the server request log. Quote this when reporting an error.

• 500 application/json

  Internal Server Error - Something went wrong

  Hide response attributes Show response attributes object

  • error string

    ADR-013: user-facing message (V2+). On frozen V1 this is the error type identifier.

  • error_type string

    Machine-readable error class the client branches on (ADR-013, e.g., "RecordNotFound")

  • message string

    Human-readable error message (legacy/V1 shape)

  • field string

    Field that caused the error, if applicable

  • error_id string

    Unique error tracking identifier

  • request_id string

    Request correlation id; mirrors the x-request-id response header and appears in the server request log. Quote this when reporting an error.