Retrieve
Retrieve a project branch
client.projects.branches.retrieve(stringbranch, BranchRetrieveParamsparams?, RequestOptionsoptions?): branchstringconfig_commitCommitlatest_buildunionobject"project_branch"orgstringprojectstringProjectBranch
get/v0/projects/{project}/branches/{branch}
Retrieve a project branch
Parameters
branchstring
paramsprojectstringBranchRetrieveParams
Returns
branchstringconfig_commitCommitlatest_buildunionobject"project_branch"orgstringprojectstringProjectBranch
import Stainless from '@stainless-api/sdk';
const client = new Stainless({
apiKey: 'My API Key',
});
const projectBranch = await client.projects.branches.retrieve('branch', { project: 'project' });
console.log(projectBranch.branch);200 Example
{
"branch": "branch",
"config_commit": {
"repo": {
"branch": "branch",
"name": "name",
"owner": "owner"
},
"sha": "sha"
},
"latest_build": {
"id": "id",
"config_commit": "config_commit",
"created_at": "2019-12-27T18:11:19.117Z",
"documented_spec": {
"content": "content",
"type": "content"
},
"object": "build",
"org": "org",
"project": "project",
"targets": {
"cli": {
"commit": {
"status": "not_started"
},
"lint": {
"status": "not_started"
},
"object": "build_target",
"status": "not_started",
"test": {
"status": "not_started"
},
"build": {
"status": "not_started"
},
"upload": {
"status": "not_started"
}
},
"csharp": {
"commit": {
"status": "not_started"
},
"lint": {
"status": "not_started"
},
"object": "build_target",
"status": "not_started",
"test": {
"status": "not_started"
},
"build": {
"status": "not_started"
},
"upload": {
"status": "not_started"
}
},
"go": {
"commit": {
"status": "not_started"
},
"lint": {
"status": "not_started"
},
"object": "build_target",
"status": "not_started",
"test": {
"status": "not_started"
},
"build": {
"status": "not_started"
},
"upload": {
"status": "not_started"
}
},
"java": {
"commit": {
"status": "not_started"
},
"lint": {
"status": "not_started"
},
"object": "build_target",
"status": "not_started",
"test": {
"status": "not_started"
},
"build": {
"status": "not_started"
},
"upload": {
"status": "not_started"
}
},
"kotlin": {
"commit": {
"status": "not_started"
},
"lint": {
"status": "not_started"
},
"object": "build_target",
"status": "not_started",
"test": {
"status": "not_started"
},
"build": {
"status": "not_started"
},
"upload": {
"status": "not_started"
}
},
"node": {
"commit": {
"status": "not_started"
},
"lint": {
"status": "not_started"
},
"object": "build_target",
"status": "not_started",
"test": {
"status": "not_started"
},
"build": {
"status": "not_started"
},
"upload": {
"status": "not_started"
}
},
"php": {
"commit": {
"status": "not_started"
},
"lint": {
"status": "not_started"
},
"object": "build_target",
"status": "not_started",
"test": {
"status": "not_started"
},
"build": {
"status": "not_started"
},
"upload": {
"status": "not_started"
}
},
"python": {
"commit": {
"status": "not_started"
},
"lint": {
"status": "not_started"
},
"object": "build_target",
"status": "not_started",
"test": {
"status": "not_started"
},
"build": {
"status": "not_started"
},
"upload": {
"status": "not_started"
}
},
"ruby": {
"commit": {
"status": "not_started"
},
"lint": {
"status": "not_started"
},
"object": "build_target",
"status": "not_started",
"test": {
"status": "not_started"
},
"build": {
"status": "not_started"
},
"upload": {
"status": "not_started"
}
},
"terraform": {
"commit": {
"status": "not_started"
},
"lint": {
"status": "not_started"
},
"object": "build_target",
"status": "not_started",
"test": {
"status": "not_started"
},
"build": {
"status": "not_started"
},
"upload": {
"status": "not_started"
}
},
"typescript": {
"commit": {
"status": "not_started"
},
"lint": {
"status": "not_started"
},
"object": "build_target",
"status": "not_started",
"test": {
"status": "not_started"
},
"build": {
"status": "not_started"
},
"upload": {
"status": "not_started"
}
}
},
"updated_at": "2019-12-27T18:11:19.117Z"
},
"object": "project_branch",
"org": "org",
"project": "project"
}