Skip to content

Branch

Database branch information

Property Type Description
created_at string When the branch was created
created_by? string User ID who created the branch
data_clone_mode DataCloneMode How data was cloned when branch was created
database_name string Actual database name
error_message? string Error message if status is ‘error’
expires_at? string When the branch will automatically expire
github_pr_number? number GitHub PR number if this is a preview branch
github_pr_url? string GitHub PR URL
github_repo? string GitHub repository (owner/repo)
id string Unique branch identifier
name string Display name of the branch
parent_branch_id? string Parent branch ID (for feature branches)
slug string URL-safe slug for the branch
status BranchStatus Current status of the branch
type BranchType Type of branch
updated_at string When the branch was last updated