TrylleDocs
API ReferenceOpenAPI 3 reference

Repository access

listRepoAssignees

GET
/v1/repositories/{owner}/{name}/assignees

List Forgejo-authoritative users eligible for assignment in this repository, including team-derived access.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

owner*string

Repository owner namespace.

Length1 <= length
name*string

Repository name from the {name} path segment.

Length1 <= length

Response Body

application/json

curl -X GET "https://example.com/v1/repositories/aa/aa/assignees"
"abc123"

searchRepoCollaboratorCandidates

GET
/v1/repositories/{owner}/{name}/collaborator-candidates

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

owner*string

Repository owner namespace.

Length1 <= length
name*string

Repository name.

Length1 <= length

Query Parameters

q?string

Search by username, email, or display name.

Response Body

application/json

curl -X GET "https://example.com/v1/repositories/aa/aa/collaborator-candidates?q=abc123"
"abc123"

listRepoCollaborators

GET
/v1/repositories/{owner}/{name}/collaborators

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

owner*string

Repository owner namespace.

Length1 <= length
name*string

Repository name from the {name} path segment.

Length1 <= length

Response Body

application/json

curl -X GET "https://example.com/v1/repositories/aa/aa/collaborators"
"abc123"

removeRepoCollaborator

DELETE
/v1/repositories/{owner}/{name}/collaborators/{username}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

owner*string

Repository owner namespace.

Length1 <= length
name*string

Repository name.

Length1 <= length
username*string

Collaborator username.

Length1 <= length

Response Body

application/json

curl -X DELETE "https://example.com/v1/repositories/aa/aa/collaborators/aa"
"abc123"

addRepoCollaborator

PUT
/v1/repositories/{owner}/{name}/collaborators/{username}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

owner*string

Repository owner namespace.

Length1 <= length
name*string

Repository name.

Length1 <= length
username*string

Forgejo login, platform username, or email of the collaborator.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PUT "https://example.com/v1/repositories/aa/aa/collaborators/aa" \  -H "Content-Type: application/json" \  -d '{    "permission": "abc123"  }'
"abc123"

listRepoReviewerTeams

GET
/v1/repositories/{owner}/{name}/reviewer-teams

List organization teams attached to a repository that may be requested as pull-request reviewers.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

owner*string

Repository owner namespace.

Length1 <= length
name*string

Repository name from the {name} path segment.

Length1 <= length

Response Body

application/json

curl -X GET "https://example.com/v1/repositories/aa/aa/reviewer-teams"
"abc123"

listRepoReviewerUsers

GET
/v1/repositories/{owner}/{name}/reviewer-users

List Forgejo-authoritative users eligible to be requested as pull-request reviewers, including team-derived access.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

owner*string

Repository owner namespace.

Length1 <= length
name*string

Repository name from the {name} path segment.

Length1 <= length

Response Body

application/json

curl -X GET "https://example.com/v1/repositories/aa/aa/reviewer-users"
"abc123"

listRepoTeams

GET
/v1/repositories/{owner}/{name}/teams

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

owner*string

Repository owner namespace.

Length1 <= length
name*string

Repository name from the {name} path segment.

Length1 <= length

Response Body

application/json

curl -X GET "https://example.com/v1/repositories/aa/aa/teams"
"abc123"

removeRepoTeam

DELETE
/v1/repositories/{owner}/{name}/teams/{team}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

owner*string

Repository owner.

Length1 <= length
name*string

Repository name.

Length1 <= length
team*string

Team slug.

Length1 <= length

Response Body

application/json

curl -X DELETE "https://example.com/v1/repositories/aa/aa/teams/aa"
"abc123"

addRepoTeam

PUT
/v1/repositories/{owner}/{name}/teams/{team}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

owner*string

Repository owner.

Length1 <= length
name*string

Repository name.

Length1 <= length
team*string

Team slug.

Length1 <= length

Response Body

application/json

curl -X PUT "https://example.com/v1/repositories/aa/aa/teams/aa"
"abc123"

Repository Git data

Previous Page

Repository CI configuration

Next Page