Archive Statement

POST /api/v1/statements/:id/archive

Marks a statement as archived (is_archived: true). Archived statements are hidden from the default list view but remain queryable with ?is_archived=true. Reversible via Unarchive Statement.

Idempotent — calling on an already-archived statement is a no-op success.

Path Parameters

ParameterTypeDescription
idstringStatement ID

Example Request

curl -X POST "https://statements.finopsbricks.com/api/v1/statements/stmt123xyz/archive" \
  -H "api-key: fob_stm_xxxxxxxxxxxx" \
  -H "api-secret: xxxxxxxxxxxxxxxx"

Response

{
  "data": {
    "id": "stmt123xyz",
    "is_archived": true
  }
}

Errors

CodeDescription
401Invalid or missing API credentials
403API key lacks statements:edit permission
404Statement not found