Skip to content
Bottle

A business's data retention and erasures

GET
/console/businesses/{id}/privacy
curl --request GET \
  --url https://example.com/console/businesses/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f/privacy \
  --cookie bottle.session_token=<bottle.session_token>

How long the business keeps customers nobody orders for, how many people have been erased and why, and how many customers are on a legal hold. Counts and dates only, never who.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required

UUID v7

string format: uuid
Example
019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

UUID v7

Responses

Section titled “Responses”

200

Section titled “200”

Retention and erasures

Media typeapplication/json
object
retention
required
object
enabled
required
boolean
years
required
integer
> 0
warnDays
required
integer
isDefault
required
boolean
erasures
required
object
total
required
integer
onRequest
required
integer
byRetention
required
integer
lastAt
required
string | null format: date-time
recent
required
Array<object>
object
id
required

UUID v7

string format: uuid
subject
required
string
Allowed values: customer user
reason
required
string
Allowed values: request retention
addressesErased
required
integer
ordersKept
required
integer
ordersDeleted
required
integer
at
required
string format: date-time
legalHolds
required
integer
Example
{
  "erasures": {
    "recent": [
      {
        "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
        "subject": "customer",
        "reason": "request"
      }
    ]
  }
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not Bottle staff, no two-step sign-in, or a console role too low for this

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

404

Section titled “404”

Not found

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string
Example
{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}