Trylle Documentation

listMyOrganizations

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v1/organizations"

"abc123"

createOrganization

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

description?string

Organization description.

Lengthlength <= 240

displayName*string

Organization display name.

Length1 <= length <= 80

handle*string

Organization handle (URL slug).

Match^[A-Za-z0-9](?:[A-Za-z0-9-]{0,37}[A-Za-z0-9])?$

Length1 <= length <= 39

isPrivate?boolean

Whether the organization is private.

Response Body

`application/json`

curl -X POST "https://example.com/v1/organizations" \  -H "Content-Type: application/json" \  -d '{    "description": "aaa",    "displayName": "aa",    "handle": "aa",    "isPrivate": false  }'

"abc123"

getOrganization

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

handle*string

Organization handle or Forgejo login.

Length1 <= length

Response Body

`application/json`

curl -X GET "https://example.com/v1/organizations/aa"

"abc123"

updateOrganization

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

handle*string

Organization handle or Forgejo login.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

description?string

Organization description.

Lengthlength <= 240

displayName?string

Organization display name.

Length1 <= length <= 80

isPrivate?boolean

Whether the organization is private.

settings?unknown

Organization settings (member privileges and repository defaults).

Response Body

`application/json`

curl -X PATCH "https://example.com/v1/organizations/aa" \  -H "Content-Type: application/json" \  -d '{    "description": "aaa",    "displayName": "aa",    "isPrivate": false,    "settings": "abc123"  }'

"abc123"

deleteOrganization

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

handle*string

Organization handle or Forgejo login.

Length1 <= length

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/organizations/aa"

"abc123"

deleteOrganizationAvatar

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

handle*string

Organization handle or Forgejo login.

Length1 <= length

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/organizations/aa/avatar"

"abc123"

setOrganizationAvatar

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

handle*string

Organization handle or Forgejo login.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

image*string

Raw base64 avatar image without a data URI prefix.

Length1 <= length <= 1400000

Response Body

`application/json`

curl -X PUT "https://example.com/v1/organizations/aa/avatar" \  -H "Content-Type: application/json" \  -d '{    "image": "aa"  }'

"abc123"

renameOrganization

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

handle*string

Organization handle or Forgejo login.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

newHandle*string

New organization handle (URL slug).

Match^[A-Za-z0-9](?:[A-Za-z0-9-]{0,37}[A-Za-z0-9])?$

Length1 <= length <= 39

Response Body

`application/json`

curl -X POST "https://example.com/v1/organizations/aa/rename" \  -H "Content-Type: application/json" \  -d '{    "newHandle": "aa"  }'

"abc123"

transferOrganizationOwnership

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

handle*string

Organization handle or Forgejo login.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

newOwner*string

Forgejo login of the member who will become owner.

Length1 <= length

Response Body

`application/json`

curl -X POST "https://example.com/v1/organizations/aa/transfer-ownership" \  -H "Content-Type: application/json" \  -d '{    "newOwner": "aa"  }'

"abc123"

getOrgProfile

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

org*string

Organization login.

Length1 <= length

Response Body

`application/json`

curl -X GET "https://example.com/v1/orgs/aa"

"abc123"

listOrgInvitations

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

org*string

Organization handle or Forgejo login.

Length1 <= length

Response Body

`application/json`

curl -X GET "https://example.com/v1/orgs/aa/invitations"

"abc123"

revokeOrgInvitation

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

org*string

Organization handle or Forgejo login.

Length1 <= length

invite_id*integer

Pending invitation id.

Formatint64

Query Parameters

team_id*integer

Forgejo team id for the invitation.

Formatint64

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/orgs/aa/invitations/1?team_id=1"

"abc123"

searchOrgMemberCandidates

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

org*string

Organization handle or Forgejo login.

Length1 <= length

Query Parameters

q?string

Search by username, email, or display name.

Response Body

`application/json`

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

"abc123"

listOrgMembers

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

org*string

Organization login.

Length1 <= length

Query Parameters

page?integer

One-indexed page. Handler clamps values below 1 to 1.

Formatint64

Range1 <= value

Default1

per_page?integer

Items per page. Handler defaults to 30 and clamps above 100.

Formatint64

Range1 <= value <= 100

Default30

Response Body

`application/json`

curl -X GET "https://example.com/v1/orgs/aa/members?page=2&per_page=2"

"abc123"

updateOrgMember

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

org*string

Organization handle or Forgejo login.

Length1 <= length

username*string

Forgejo login of the member to update.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

role*string

New organization role.

Value in

"admin"
"member"

Response Body

`application/json`

curl -X PATCH "https://example.com/v1/orgs/aa/members/aa" \  -H "Content-Type: application/json" \  -d '{    "role": "member"  }'

"abc123"

removeOrgMember

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

org*string

Organization handle or Forgejo login.

Length1 <= length

username*string

Forgejo login of the member to remove.

Length1 <= length

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/orgs/aa/members/aa"

"abc123"

addOrgMember

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

org*string

Organization handle or Forgejo login.

Length1 <= length

username*string

Forgejo login, platform username, or email of the user to invite.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

role?string

Organization role for the new member.

Value in

"admin"
"member"

Response Body

`application/json`

curl -X PUT "https://example.com/v1/orgs/aa/members/aa" \  -H "Content-Type: application/json" \  -d '{    "role": "member"  }'

"abc123"

setOrgMemberVisibility

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

org*string

Organization handle or Forgejo login.

Length1 <= length

username*string

Forgejo login of the member to update.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

public*boolean

Whether this member is visible on the public organization profile.

Response Body

`application/json`

curl -X PATCH "https://example.com/v1/orgs/aa/members/aa/visibility" \  -H "Content-Type: application/json" \  -d '{    "public": false  }'

"abc123"

getOrgPinnedRepositories

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

org*string

Organization login.

Length1 <= length

Response Body

`application/json`

curl -X GET "https://example.com/v1/orgs/aa/pinned-repositories"

"abc123"

setOrgPinnedRepositories

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

org*string

Organization handle or Forgejo login.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

repositories?array<string>

Ordered repository full names (owner/name) to pin.

Response Body

`application/json`

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

"abc123"

Organizations

200application/json

201application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`