Projects
Project CRUD — each project groups one or more pipelines. Per-project role assignments for granular RBAC.
Authorization
bearer_auth In: header
Query Parameters
Page size (default 50)
int64Page offset (default 0)
int64Filter by name (case-insensitive partial match)
Filter by linked integration
Sort by activity (pinned apps, then newest build), created_at, updated_at, or name
Sort direction: asc or desc
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/projects"{ "projects": [ { "auto_add_pipelines": true, "created_at": 0, "created_by": "string", "current_user_role": "maintainer", "default_branch": "string", "description": "string", "id": "string", "is_favorite": true, "last_build_at": 0, "live_version": "string", "name": "string", "platforms": [ "android" ], "repository_avatar_url": "string", "repository_full_name": "string", "repository_id": "string", "repository_provider": null, "settings": {}, "updated_at": 0 } ], "total": 0}Authorization
bearer_auth In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/v1/projects" \ -H "Content-Type: application/json" \ -d '{ "name": "string" }'{ "project": { "auto_add_pipelines": true, "created_at": 0, "created_by": "string", "current_user_role": "maintainer", "default_branch": "string", "description": "string", "id": "string", "is_favorite": true, "last_build_at": 0, "live_version": "string", "name": "string", "platforms": [ "android" ], "repository_avatar_url": "string", "repository_full_name": "string", "repository_id": "string", "repository_provider": null, "settings": {}, "updated_at": 0 }}Local Only instances: runs flutter create in the backend's data
folder, commits it to a new Git repository and adds it as an app named
"Sample app", so a first build works before any code of your own.
Authorization
bearer_auth In: header
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/v1/projects/sample"{ "project": { "auto_add_pipelines": true, "created_at": 0, "created_by": "string", "current_user_role": "maintainer", "default_branch": "string", "description": "string", "id": "string", "is_favorite": true, "last_build_at": 0, "live_version": "string", "name": "string", "platforms": [ "android" ], "repository_avatar_url": "string", "repository_full_name": "string", "repository_id": "string", "repository_provider": null, "settings": {}, "updated_at": 0 }}Authorization
bearer_auth In: header
Path Parameters
Project ID
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/projects/string"{ "build_count": 0, "current_user_role": "maintainer", "pipeline_count": 0, "project": { "auto_add_pipelines": true, "created_at": 0, "created_by": "string", "current_user_role": "maintainer", "default_branch": "string", "description": "string", "id": "string", "is_favorite": true, "last_build_at": 0, "live_version": "string", "name": "string", "platforms": [ "android" ], "repository_avatar_url": "string", "repository_full_name": "string", "repository_id": "string", "repository_provider": null, "settings": {}, "updated_at": 0 }, "setup": { "release_signing": true, "store_publishing": true, "testers": true }}Authorization
bearer_auth In: header
Path Parameters
Project ID
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X PATCH "https://example.com/v1/projects/string" \ -H "Content-Type: application/json" \ -d '{}'{ "project": { "auto_add_pipelines": true, "created_at": 0, "created_by": "string", "current_user_role": "maintainer", "default_branch": "string", "description": "string", "id": "string", "is_favorite": true, "last_build_at": 0, "live_version": "string", "name": "string", "platforms": [ "android" ], "repository_avatar_url": "string", "repository_full_name": "string", "repository_id": "string", "repository_provider": null, "settings": {}, "updated_at": 0 }}Authorization
bearer_auth In: header
Path Parameters
Project ID
Response Body
application/json
application/json
application/json
curl -X DELETE "https://example.com/v1/projects/string"{ "ok": true}Reads pubspec.yaml, the platform folders and Oore config files on
the project's default branch through its source provider, so the web
UI can propose the app's first pipelines.
Authorization
bearer_auth In: header
Path Parameters
Project ID
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/projects/string/app-detection"{ "app_name": "string", "config_files": [ "string" ], "flutter": true, "platforms": [ "android" ], "reference": "string"}Authorization
bearer_auth In: header
Path Parameters
Project ID
Response Body
curl -X DELETE "https://example.com/v1/projects/string/favorite"Pins the app for the signed-in person: it sorts first in the app list, and its store releases reach their notifications.
Authorization
bearer_auth In: header
Path Parameters
Project ID
Response Body
application/json
curl -X PUT "https://example.com/v1/projects/string/favorite"Authorization
bearer_auth In: header
Path Parameters
Project ID
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/projects/string/members"{ "members": [ { "created_at": 0, "id": "string", "project_id": "string", "role": "maintainer", "updated_at": 0, "user_avatar_url": "string", "user_display_name": "string", "user_email": "string", "user_id": "string", "user_role": "string" } ]}Authorization
bearer_auth In: header
Path Parameters
Project ID
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/projects/string/members" \ -H "Content-Type: application/json" \ -d '{ "role": "maintainer", "user_id": "string" }'{ "member": { "created_at": 0, "id": "string", "project_id": "string", "role": "maintainer", "updated_at": 0, "user_avatar_url": "string", "user_display_name": "string", "user_email": "string", "user_id": "string", "user_role": "string" }}Authorization
bearer_auth In: header
Path Parameters
Project ID
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/projects/string/members/candidates"{ "candidates": [ { "display_name": "string", "email": "string", "id": "string", "role": "string", "status": "string" } ]}Authorization
bearer_auth In: header
Path Parameters
Project ID
User ID
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X PATCH "https://example.com/v1/projects/string/members/string" \ -H "Content-Type: application/json" \ -d '{ "role": "maintainer" }'{ "member": { "created_at": 0, "id": "string", "project_id": "string", "role": "maintainer", "updated_at": 0, "user_avatar_url": "string", "user_display_name": "string", "user_email": "string", "user_id": "string", "user_role": "string" }}Authorization
bearer_auth In: header
Path Parameters
Project ID
User ID
Response Body
application/json
application/json
curl -X DELETE "https://example.com/v1/projects/string/members/string"{ "ok": true}The project credential library. Key material is never returned.
Authorization
bearer_auth In: header
Path Parameters
Project ID
Response Body
application/json
curl -X GET "https://example.com/v1/projects/string/signing-identities"{ "identities": [ { "created_at": 0, "expires_at": 0, "export_method": null, "filename": "string", "id": "string", "key_alias": "string", "kind": "android_keystore", "name": "string", "profiles": [ { "bundle_id": "string", "expires_at": 0, "profile_name": "string", "profile_uuid": "string" } ], "project_id": "string", "team_id": "string", "updated_at": 0, "used_by": [ { "pipeline_id": "string", "pipeline_name": "string", "workflow": "string" } ] } ]}An Android keystore, or an iOS distribution certificate with its
provisioning profiles. A v2 file names it under signing.
Authorization
bearer_auth In: header
Path Parameters
Project ID
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Create a signing identity. Set the input matching kind.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/v1/projects/string/signing-identities" \ -H "Content-Type: application/json" \ -d '{ "kind": "android_keystore", "name": "string" }'{ "identity": { "created_at": 0, "expires_at": 0, "export_method": null, "filename": "string", "id": "string", "key_alias": "string", "kind": "android_keystore", "name": "string", "profiles": [ { "bundle_id": "string", "expires_at": 0, "profile_name": "string", "profile_uuid": "string" } ], "project_id": "string", "team_id": "string", "updated_at": 0, "used_by": [ { "pipeline_id": "string", "pipeline_name": "string", "workflow": "string" } ] }}Authorization
bearer_auth In: header
Path Parameters
Project ID
Identity ID
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Rename an identity, or replace its material (the whole input for its kind).
Response Body
application/json
application/json
curl -X PATCH "https://example.com/v1/projects/string/signing-identities/string" \ -H "Content-Type: application/json" \ -d '{}'{ "identity": { "created_at": 0, "expires_at": 0, "export_method": null, "filename": "string", "id": "string", "key_alias": "string", "kind": "android_keystore", "name": "string", "profiles": [ { "bundle_id": "string", "expires_at": 0, "profile_name": "string", "profile_uuid": "string" } ], "project_id": "string", "team_id": "string", "updated_at": 0, "used_by": [ { "pipeline_id": "string", "pipeline_name": "string", "workflow": "string" } ] }}Refused while a pipeline's workflow settings pick it.
Authorization
bearer_auth In: header
Path Parameters
Project ID
Identity ID
Response Body
application/json
application/json
curl -X DELETE "https://example.com/v1/projects/string/signing-identities/string"{ "ok": true}