Responses

• 200 application/json

  Successful response

  Hide response attributes Show response attributes object

  • user_id string
  • shrimp string

    Default value is empty.

  • records array[object] Required
    Hide records attributes Show records attributes object

    • identifier string Required
    • key string Required
    • shortid string Required
    • state string Required

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

    • owner_id string | null
    • created number Required
    • updated number Required
    • shared number | null
    • previewed number | null
    • revealed number | null
    • burned number | null
    • secret_ttl number Required
    • receipt_ttl number Required
    • lifespan number Required
    • secret_shortid string
    • 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 boolean Required
    • is_revealed boolean Required
    • is_burned boolean Required
    • is_destroyed boolean Required
    • is_expired boolean Required
    • is_orphaned boolean Required
    • 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.

    • show_recipients boolean Required
  • details object
    Hide details attributes Show details attributes object

    • type string Required
    • scope string | null
    • scope_label string | null
    • since number Required
    • now number Required
    • has_items boolean Required
    • revealed_receipts array[object]
      Hide revealed_receipts attributes Show revealed_receipts attributes object

      • identifier string Required
      • key string Required
      • shortid string Required
      • state string Required

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

      • owner_id string | null
      • created number Required
      • updated number Required
      • shared number | null
      • previewed number | null
      • revealed number | null
      • burned number | null
      • secret_ttl number Required
      • receipt_ttl number Required
      • lifespan number Required
      • secret_shortid string
      • 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 boolean Required
      • is_revealed boolean Required
      • is_burned boolean Required
      • is_destroyed boolean Required
      • is_expired boolean Required
      • is_orphaned boolean Required
      • 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.

      • show_recipients boolean Required
    • pending_receipts array[object]
      Hide pending_receipts attributes Show pending_receipts attributes object

      • identifier string Required
      • key string Required
      • shortid string Required
      • state string Required

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

      • owner_id string | null
      • created number Required
      • updated number Required
      • shared number | null
      • previewed number | null
      • revealed number | null
      • burned number | null
      • secret_ttl number Required
      • receipt_ttl number Required
      • lifespan number Required
      • secret_shortid string
      • 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 boolean Required
      • is_revealed boolean Required
      • is_burned boolean Required
      • is_destroyed boolean Required
      • is_expired boolean Required
      • is_orphaned boolean Required
      • 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.

      • show_recipients boolean Required
  • count integer

    Minimum value is -9007199254740991, maximum value is 9007199254740991.

• 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.