Skip to content

Branch

Database branch information

PropertyTypeDescription
created_atstringWhen the branch was created
created_by?stringUser ID who created the branch
data_clone_modeDataCloneModeHow data was cloned when branch was created
database_namestringActual database name
error_message?stringError message if status is ‘error’
expires_at?stringWhen the branch will automatically expire
github_pr_number?numberGitHub PR number if this is a preview branch
github_pr_url?stringGitHub PR URL
github_repo?stringGitHub repository (owner/repo)
idstringUnique branch identifier
namestringDisplay name of the branch
parent_branch_id?stringParent branch ID (for feature branches)
slugstringURL-safe slug for the branch
statusBranchStatusCurrent status of the branch
typeBranchTypeType of branch
updated_atstringWhen the branch was last updated