---
title: "Get Workspace Backup Api"
method: GET
path: "/workspace/backup/{backup_id}"
tags: ["Workspace backup"]
---

# Get Workspace Backup Api

`GET /workspace/backup/{backup_id}`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/workspace/backup/{backup_id}`
- Auth: HTTP bearer

One of this key's backups (status, scope, size, sha256, per-section counts, expiry).

## Path parameters

- `backup_id` string, uuid, required

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Response `200`

Successful Response

- ApiResponseBackupJobResponse
  - `data` BackupJobResponse, required: A workspace backup: ``complete`` (made by a workspace administrator: every object, field, grant and report) or ``restricted`` (exactly what the requester could read). The archive is deleted 14 days after ``created_at``.
    - `id` string, uuid, required
    - `status` 'pending' | 'running' | 'completed' | 'failed' | 'expired', required
    - `scope` 'complete' | 'restricted', nullable
    - `format_version` integer, nullable
    - `archive_bytes` integer, nullable
    - `archive_sha256` string, nullable
    - `counts` object: Rows per archive section.
    - `error_code` string, nullable
    - `requested_by` BackupRequester, required: Who asked. ``name`` and ``kind`` are shown to a workspace administrator only (anyone else lists only their own jobs and reads ``is_you``); ``name`` is the member's display name, None for an API key or an unknown member.
      - `is_you` boolean, required
      - `name` string, nullable
      - `kind` 'member' | 'api_key', nullable
    - `created_at` string, date-time, required
    - `started_at` string, date-time, nullable
    - `completed_at` string, date-time, nullable
    - `expires_at` string, date-time, nullable
    - `download_available` boolean
    - `restorable` boolean: Only a complete backup can be restored.
    - `not_restorable_reason` 'restricted_backup' | 'expired' | 'not_completed', nullable: ``restricted_backup``: made with restricted access, so it cannot be restored.
    - `history` 'included' | 'omitted', nullable: Whether the archive holds record history (who changed what). Null until the backup has run (and for a backup made before this was recorded).
    - `history_reason` 'audit_permission_required' | 'audit_log_switched_off', nullable: Why history was left out: ``audit_permission_required`` (the requester lacks objects:audit) or ``audit_log_switched_off`` (the audit log is off for this workspace). Null when included or unknown.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)