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 | null
    • 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 | number Required

      Any of:

      string-1 string number-2 number
    • receipt_ttl string | null Required
    • lifespan string | null Required
    • secret_shortid string | null
    • secret_identifier string | null

    • recipients array[string] | null | string

      Any of:

      array-1 array[string] | null string-2 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 .

    • received string | null
    • viewed string | null
    • is_viewed string | null
    • is_received string | null
    • show_recipients string | null
  • details object
    Hide details attributes Show details attributes object

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

      • identifier string | null
      • 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 | number Required

        Any of:

        string-1 string number-2 number
      • receipt_ttl string | null Required
      • lifespan string | null Required
      • secret_shortid string | null
      • secret_identifier string | null

      • recipients array[string] | null | string

        Any of:

        array-1 array[string] | null string-2 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 .

      • received string | null
      • viewed string | null
      • is_viewed string | null
      • is_received string | null
      • show_recipients string | null
    • notreceived array[object]
      Hide notreceived attributes Show notreceived attributes object

      • identifier string | null
      • 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 | number Required

        Any of:

        string-1 string number-2 number
      • receipt_ttl string | null Required
      • lifespan string | null Required
      • secret_shortid string | null
      • secret_identifier string | null

      • recipients array[string] | null | string

        Any of:

        array-1 array[string] | null string-2 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 .

      • received string | null
      • viewed string | null
      • is_viewed string | null
      • is_received string | null
      • show_recipients string | null
  • 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

    Error type identifier (e.g., "FormError")

  • message string Required

    Human-readable error message

  • field string

    Field that caused the error, if applicable

  • error_id string

    Unique error tracking identifier

• 403 application/json

  Forbidden - Insufficient permissions

  Hide response attributes Show response attributes object

  • error string

    Error type identifier (e.g., "FormError")

  • message string Required

    Human-readable error message

  • field string

    Field that caused the error, if applicable

  • error_id string

    Unique error tracking identifier

• 404 application/json

  Not Found - Resource does not exist

  Hide response attributes Show response attributes object

  • error string

    Error type identifier (e.g., "FormError")

  • message string Required

    Human-readable error message

  • field string

    Field that caused the error, if applicable

  • error_id string

    Unique error tracking identifier

• 500 application/json

  Internal Server Error - Something went wrong

  Hide response attributes Show response attributes object

  • error string

    Error type identifier (e.g., "FormError")

  • message string Required

    Human-readable error message

  • field string

    Field that caused the error, if applicable

  • error_id string

    Unique error tracking identifier