Folders

Get a folder status

Returns the latest folder-copy reports grouped by sign-in, with receipt ages and totals from sign-ins that still stand. A sign-in's reports stay as history until its key or app grant is removed.

GET
/folders/{id}/status

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Path parameters

id*string

The ID of the folder.

Response body

About errors

Returns current and historical reports and the current totals.

application/json
  1. response

A folder's sync reports grouped by existing sign-in.

folder_id*string

The ID of the folder.

sign_ins*array<>

Current and historical reports, grouped by sign-in; age is no claim of being online.

totals*

Totals from current sign-ins alone; copies may contain overlapping files.

  • invalid_id: the folder ID is malformed.
  • validation_error: the query names an undeclared field, or the request asks for an unsupported conditional copy read.
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.

  • type_not_permitted: your credential reads no type.
application/json
  1. response

An error response.

error*

What went wrong.

  • item_not_found: the folder does not exist or you cannot read 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/folders/string/status'
About errors
{  "folder_id": "01920000-0000-7000-8000-000000000002",  "sign_ins": [    {      "sign_in": {        "kind": "key",        "id": "01920000-0000-7000-8000-000000000001",        "name": "Folder sync"      },      "current": true,      "copies": [        {          "folder_store_id": "01920000-0000-7000-8000-000000000000",          "sequence": 1,          "last_success_at": null,          "pending_uploads": 2,          "pending_downloads": 0,          "paused_removals": 0,          "first_sync_waiting": false,          "problems": [            {              "code": "conflict",              "count": 1            }          ],          "received_at": "2026-10-03T09:30:00.000Z",          "age_seconds": 60        }      ]    }  ],  "totals": {    "saturated": false,    "pending_uploads": 2,    "pending_downloads": 0,    "paused_removals": 0,    "first_sync_waiting": 0,    "problems": [      {        "code": "conflict",        "count": 1      }    ]  }}