GET /organizations/{organization_uuid}/projects
Lists all projects that your user has access to within the supplied organization.
To filter the results by project type, you can use type
as additional
query parameters. The name
query parameter allows you to get a
specific project by name/repository.
-
name
refers to the repository name, which is also the project name you see in the UI. You must supply the full name. -
type
refers to the type of project, so eitherbasic
orpro
can be used as values. To get both types, don’t include the type filter.
Query string
Field name | Type | Required |
---|---|---|
per_page |
number |
|
page |
number |
|
name |
string |
|
type |
string Allowed values: basic, pro |
Response schema
-
Content type: application/json
-
Response schema type: array[object]
Field name | Type |
---|---|
aes_key |
string |
uuid |
string |
organization_uuid |
string |
authentication_user |
string |
name |
string |
repository_provider |
string |
ssh_key |
string |
repository_url |
string |
type |
string Allowed values: basic, pro |
created_at |
string |
updated_at |
string |
build_on_pr_only |
boolean |
branch_match |
string Allowed values: include, exclude |
branches |
array[string] |
setup_commands |
array[string] |
test_pipelines |
array[object] |
|
integer |
|
string |
|
array[string] |
team_ids |
array[number] |
notification_rules |
array[object] |
|
string Allowed values: email, slack, campfire, webhook |
|
string Allowed values: all, committer |
|
string |
|
object |
key |
string |
url |
string |
room |
string |
|
array[string] Allowed values: started, failed, success, recovered |
|
string Allowed values: exact, regex, wildcard |
environment_variables |
array[object] |
|
string |
|
string |
deployment_pipelines |
array[object] |
|
integer |
|
object |
branch_name |
string |
match_mode |
string |
|
object |
|
integer |
Code examples
curl --request GET \ --url 'https://api.codeship.com/v2/organizations/721cea10-b6a5-0104-5b93-5240c481c5a2/projects?type=pro&page=1&per_page=3' \ --header 'authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9' \ --data '{}'
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://api.codeship.com/v2/organizations/721cea10-b6a5-0104-5b93-5240c481c5a2/projects?type=pro&page=1&per_page=3" payload := strings.NewReader("{}") req, _ := http.NewRequest("GET", url, payload) req.Header.Add("authorization", "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/octet-stream"); RequestBody body = RequestBody.create(mediaType, "{}"); Request request = new Request.Builder() .url("https://api.codeship.com/v2/organizations/721cea10-b6a5-0104-5b93-5240c481c5a2/projects?type=pro&page=1&per_page=3") .get() .addHeader("authorization", "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "api.codeship.com", "port": null, "path": "/v2/organizations/721cea10-b6a5-0104-5b93-5240c481c5a2/projects?type=pro&page=1&per_page=3", "headers": { "authorization": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write("{}"); req.end();
<?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => "https://api.codeship.com/v2/organizations/721cea10-b6a5-0104-5b93-5240c481c5a2/projects?type=pro&page=1&per_page=3", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_POSTFIELDS => "{}", CURLOPT_HTTPHEADER => array( "authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9" ), )); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; }
import http.client conn = http.client.HTTPSConnection("api.codeship.com") payload = "{}" headers = { 'authorization': "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9" } conn.request("GET", "/v2/organizations/721cea10-b6a5-0104-5b93-5240c481c5a2/projects?type=pro&page=1&per_page=3", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
require 'uri' require 'net/http' url = URI("https://api.codeship.com/v2/organizations/721cea10-b6a5-0104-5b93-5240c481c5a2/projects?type=pro&page=1&per_page=3") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["authorization"] = 'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9' request.body = "{}" response = http.request(request) puts response.read_body
var client = new RestClient("https://api.codeship.com/v2/organizations/721cea10-b6a5-0104-5b93-5240c481c5a2/projects?type=pro&page=1&per_page=3"); var request = new RestRequest(Method.GET); request.AddHeader("authorization", "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9"); request.AddParameter("undefined", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request);