DatabaseBranch

Fields

Field	Type	Description
id *	string
name *	string
source_database_id *	string
database_id	string or null	The database created for the branch.
environment_id	string	Environment the branch is attached to.
from_time	string (date-time) or null
masked	boolean
masking	MaskingRules
status *	creating, masking, available, failed, deleting
created_at *	string (date-time)

* always present

Example

{
  "id": "dbb_01jbx2m9k7q4r8t5v6w3y0z1pr",
  "name": "string",
  "source_database_id": "string",
  "database_id": "string",
  "environment_id": "string",
  "from_time": "2026-10-22T13:05:00Z",
  "masked": false,
  "masking": {
    "clients.full_name": "fake_name",
    "clients.nhs_number": null,
    "clients.date_of_birth": "shift_days(±30)",
    "carers.email": "hash_email"
  },
  "status": "creating",
  "created_at": "2026-10-22T13:05:00Z"
}

Used by

• Get a branch