Textual terminal app for browsing Braze workspace objects, viewing counts, and exporting backups as JSON.

python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

If you see endpoint or API key auth errors, verify the endpoint for your workspace:

• Login: https://dashboard.braze.com/developers/sign_in
• Endpoint docs: https://www.braze.com/docs/api/basics/#endpoints

export BRAZE_REST_ENDPOINT="https://rest.iad-06.braze.com"
export BRAZE_API_KEY="your-rest-api-key"
# optional
export BRAZE_EXPORT_DIR="exports"

python main.py
# or
python -m braze_export

Startup includes an auth preflight and reports unauthorized REST endpoint responses with the API message.

• X (Shift+X): Export selected object type (all objects in that type)
• A (Shift+A): Export all object types one at a time
• r: Refresh
• q: Quit

Navigation keys:

• Enter or Right: Open selected type
• Left, Esc, Backspace, or Delete: Back or cancel

• Exports are saved to stable mirror files: BRAZE_EXPORT_DIR/<type_key>_export.json
• Re-running export updates the same file (no run folders, no timestamp paths)
• Per-type checkpoints are saved to BRAZE_EXPORT_DIR/<type_key>_checkpoint.json
• Per-object details are cached in BRAZE_EXPORT_DIR/<type_key>_details/ and reused when unchanged
• Existing unchanged object files are skipped on re-export
• Includes history.jsonl for export events
• Type table shows Exported and % progress from these stable per-type export files