Trash

List the trash

Returns a page of trash summaries, newest creation first, without item content, of the types you can write. Requires items.purge.

GET
/trash

Authorization

bearerAuth
headerAuthorizationBearer <token>

Authenticate with an API key (marfa_k1_…) or an OAuth access token (marfa_at_…).

Query parameters

type?string

Only return items of this exact type.

q?string

Only return item names containing this text, ignoring case and surrounding whitespace.

Lengthlength <= 500
cursor?string

The next_cursor from the previous page. Leave it out to get the first page.

limit?integer

The maximum number of results to return.

Range1 <= value <= 200
Default25

Response body

About errors

Returns trash summaries and the effective retention in days. Zero disables automatic expiry.

application/json
  1. response

A page of trashed item summaries.

data*array<>

The trashed items on this page.

next_cursor*|

Pass as cursor for the next page; null on the last. A page can be short, or empty, with a cursor still to follow, so a walk stops on null and never on a short page.

retention_days*integer

How many days after deletion an item becomes eligible for automatic expiry; zero disables expiry.

validation_error: invalid page or cursor.

application/json
  1. response

An error response.

error*

What went wrong.

unauthorized: the request has no credential, or its credential is not valid. For a key that has expired, details.expired_at says when it expired.

application/json
  1. response

An error response.

error*

What went wrong.

  • forbidden: the credential lacks items.purge. details.required_scope names it.
application/json
  1. response

An error response.

error*

What went wrong.

contract_mismatch: X-Marfa-Contract names another contract version than this instance speaks, or is not a whole number. Nothing was done.

application/json
  1. response

An error response.

error*

What went wrong.

rate_limited: you sent too many requests. Wait for the number of seconds in Retry-After, then try again.

application/json
  1. response

An error response.

error*

What went wrong.

internal_error: Marfa failed in a way it didn't expect, and the request may not have completed. Read what you changed before you repeat a write.

application/json
  1. response

An error response.

error*

What went wrong.

write_contention: the database was busy, and Marfa couldn't complete the request in time. Nothing changed. Try the request again. While a restore runs, details.reason is restore_running.

application/json
  1. response

An error response.

error*

What went wrong.

insufficient_storage: the disk that holds the instance's data has no room for the request, or the request would leave less free than the instance keeps in reserve. Nothing changed, unless details.write_outcome is unknown, which means the write may have landed: read what you changed before you repeat it. Free space on the disk, then try the request again.

application/json
  1. response

An error response.

error*

What went wrong.

curl -X GET 'http://localhost:8600/trash'
About errors
{  "data": [    {      "id": "01a1011a-c2a3-78ab-88fe-01dda6454da2",      "type": "acme.contact",      "version": 1,      "name": "Casey Sample",      "source": "crm",      "created_at": "2026-10-03T09:44:15.777Z",      "trashed_at": "2026-10-03T09:47:15.447Z",      "trashed_by": {        "kind": "key",        "id": "01a1011b-b5e5-7be6-8f3b-77492475b5a4",        "name": "CRM sync"      },      "eligible_for_deletion_at": "2026-10-03T10:26:00.165Z"    }  ],  "next_cursor": null,  "retention_days": 60}