How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Forgejo organization API

The organization API from Forgejo — 42 operation(s) for organization.

Forgejo organization API is one of 10 APIs that Forgejo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Organization. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 69 operations across 42 paths, and defines 60 schemas. It is described by OpenAPI 2.0, at version 16.0.0-dev-465-4b83448b7d+gitea-1.22.0.

Requests are made against the base URL https://code.forgejo.org/api/v1.

69 operations 42 paths 60 schemas 12 DELETE36 GET4 PATCH10 POST7 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
16.0.0-dev-465-4b83448b7d+gitea-1.22.0
Base URL
https://code.forgejo.org/api/v1
Authentication
API Key, basic, API Key, API Key, API Key
Resource Areas
1

Authentication & Security 5

Forgejo organization API declares 5 security schemes for authenticating requests. An API key is passed in the header as Authorization (AuthorizationHeaderToken). It defines a basic scheme (BasicAuth). An API key is passed in the header as Sudo (SudoHeader). An API key is passed in the query as sudo (SudoParam). An API key is passed in the header as X-FORGEJO-OTP (TOTPHeader). By default, every request must be authenticated.

  • AuthorizationHeaderToken — API tokens must be prepended with "token" followed by a space.
  • SudoHeader — Sudo API request as the user provided as the key. Admin privileges are required.
  • SudoParam — Sudo API request as the user provided as the key. Admin privileges are required.
  • TOTPHeader — Must be used in combination with BasicAuth if two-factor authentication is enabled.

Paths & Operations 69

Across 42 paths, the API surfaces 69 operations — 12 DELETE, 36 GET, 4 PATCH, 10 POST, 7 PUT. Each is listed below with its method, path, parameters, and response codes.

organization 69
POST
/org/{org}/reposdeprecated
Create a repository in an organization
createOrgRepoDeprecated 2 params → 201403404422
GET
/orgs
List all organizations
orgGetAll 2 params → 200
POST
/orgs
Create an organization
orgCreate 1 param → 201403422
GET
/orgs/{org}
Get an organization
orgGet 1 param → 200404
DELETE
/orgs/{org}
Delete an organization
orgDelete 1 param → 204404
PATCH
/orgs/{org}
Edit an organization
orgEdit 2 params → 200404422
GET
/orgs/{org}/actions/runners
Get the organization's runners
getOrgRunners 4 params → 200400404
POST
/orgs/{org}/actions/runners
Register a new organization-level runner
registerOrgRunner 2 params → 201400401404
GET
/orgs/{org}/actions/runners/jobs
Search for organization's action jobs according filter conditions
orgSearchRunJobs 2 params → 200403
GET
/orgs/{org}/actions/runners/registration-tokendeprecated
Get the organization's runner registration token
orgGetRunnerRegistrationToken 1 param → 200
GET
/orgs/{org}/actions/runners/{runner_id}
Get a particular runner that belongs to the organization
getOrgRunner 2 params → 200400404
DELETE
/orgs/{org}/actions/runners/{runner_id}
Delete a particular runner that belongs to the organization
deleteOrgRunner 2 params → 204400404
GET
/orgs/{org}/actions/secrets
List actions secrets of an organization
orgListActionsSecrets 3 params → 200404
PUT
/orgs/{org}/actions/secrets/{secretname}
Create or Update a secret value in an organization
updateOrgSecret 3 params → 201204400404
DELETE
/orgs/{org}/actions/secrets/{secretname}
Delete a secret in an organization
deleteOrgSecret 2 params → 204400404
GET
/orgs/{org}/actions/variables
List variables of an organization
getOrgVariablesList 3 params → 200400404
GET
/orgs/{org}/actions/variables/{variablename}
Get organization's variable by name
getOrgVariable 2 params → 200400404
PUT
/orgs/{org}/actions/variables/{variablename}
Update variable in organization
updateOrgVariable 3 params → 201204400404
POST
/orgs/{org}/actions/variables/{variablename}
Create a new variable in organization
createOrgVariable 3 params → 201204400404
DELETE
/orgs/{org}/actions/variables/{variablename}
Delete organization's variable by name
deleteOrgVariable 2 params → 204400404
GET
/orgs/{org}/activities/feeds
List an organization's activity feeds
orgListActivityFeeds 4 params → 200404
POST
/orgs/{org}/avatar
Update an organization's avatar
orgUpdateAvatar 2 params → 204404
DELETE
/orgs/{org}/avatar
Delete an organization's avatar. It will be replaced by a default one
orgDeleteAvatar 1 param → 204404
PUT
/orgs/{org}/block/{username}
Blocks a user from the organization
orgBlockUser 2 params → 204404422
GET
/orgs/{org}/hooks
List an organization's webhooks
orgListHooks 3 params → 200404
POST
/orgs/{org}/hooks
Create a hook
orgCreateHook 2 params → 201404
GET
/orgs/{org}/hooks/{id}
Get a hook
orgGetHook 2 params → 200404
DELETE
/orgs/{org}/hooks/{id}
Delete a hook
orgDeleteHook 2 params → 204404
PATCH
/orgs/{org}/hooks/{id}
Update a hook
orgEditHook 3 params → 200404
GET
/orgs/{org}/labels
List an organization's labels
orgListLabels 4 params → 200404
POST
/orgs/{org}/labels
Create a label for an organization
orgCreateLabel 2 params → 201404422
GET
/orgs/{org}/labels/{id}
Get a single label
orgGetLabel 2 params → 200404
DELETE
/orgs/{org}/labels/{id}
Delete a label
orgDeleteLabel 2 params → 204404
PATCH
/orgs/{org}/labels/{id}
Update a label
orgEditLabel 3 params → 200404422
GET
/orgs/{org}/list_blocked
List the organization's blocked users
orgListBlockedUsers 3 params → 200
GET
/orgs/{org}/members
List an organization's members
orgListMembers 3 params → 200404
GET
/orgs/{org}/members/{username}
Check if a user is a member of an organization
orgIsMember 2 params → 204303404
DELETE
/orgs/{org}/members/{username}
Remove a member from an organization
orgDeleteMember 2 params → 204404
GET
/orgs/{org}/public_members
List an organization's public members
orgListPublicMembers 3 params → 200404
GET
/orgs/{org}/public_members/{username}
Check if a user is a public member of an organization
orgIsPublicMember 2 params → 204404
PUT
/orgs/{org}/public_members/{username}
Publicize a user's membership
orgPublicizeMember 2 params → 204403404
DELETE
/orgs/{org}/public_members/{username}
Conceal a user's membership
orgConcealMember 2 params → 204403404
GET
/orgs/{org}/quota
Get quota information for an organization
orgGetQuota 1 param → 200403404
GET
/orgs/{org}/quota/artifacts
List the artifacts affecting the organization's quota
orgListQuotaArtifacts 3 params → 200403404
GET
/orgs/{org}/quota/attachments
List the attachments affecting the organization's quota
orgListQuotaAttachments 3 params → 200403404
GET
/orgs/{org}/quota/check
Check if the organization is over quota for a given subject
orgCheckQuota 2 params → 200403404422
GET
/orgs/{org}/quota/packages
List the packages affecting the organization's quota
orgListQuotaPackages 3 params → 200403404
POST
/orgs/{org}/rename
Rename an organization
renameOrg 2 params → 204403422
GET
/orgs/{org}/repos
List an organization's repos
orgListRepos 3 params → 200404
POST
/orgs/{org}/repos
Create a repository in an organization
createOrgRepo 2 params → 201400403404
GET
/orgs/{org}/teams
List an organization's teams
orgListTeams 3 params → 200404
POST
/orgs/{org}/teams
Create a team
orgCreateTeam 2 params → 201404422
GET
/orgs/{org}/teams/search
Search for teams within an organization
teamSearch 5 params → 200404
PUT
/orgs/{org}/unblock/{username}
Unblock a user from the organization
orgUnblockUser 2 params → 204404422
GET
/teams/{id}
Get a team
orgGetTeam 1 param → 200404
DELETE
/teams/{id}
Delete a team
orgDeleteTeam 1 param → 204404
PATCH
/teams/{id}
Edit a team
orgEditTeam 2 params → 200404
GET
/teams/{id}/activities/feeds
List a team's activity feeds
orgListTeamActivityFeeds 4 params → 200404
GET
/teams/{id}/members
List a team's members
orgListTeamMembers 3 params → 200404
GET
/teams/{id}/members/{username}
List a particular member of team
orgListTeamMember 2 params → 200404
PUT
/teams/{id}/members/{username}
Add a team member
orgAddTeamMember 2 params → 204404
DELETE
/teams/{id}/members/{username}
Remove a team member
orgRemoveTeamMember 2 params → 204404
GET
/teams/{id}/repos
List a team's repos
orgListTeamRepos 3 params → 200404
GET
/teams/{id}/repos/{org}/{repo}
List a particular repo of team
orgListTeamRepo 3 params → 200404
PUT
/teams/{id}/repos/{org}/{repo}
Add a repository to a team
orgAddTeamRepository 3 params → 204403404
DELETE
/teams/{id}/repos/{org}/{repo}
Remove a repository from a team
orgRemoveTeamRepository 3 params → 204403404
GET
/user/orgs
List the current user's organizations
orgListCurrentUserOrgs 2 params → 200401403404
GET
/users/{username}/orgs
List a user's organizations
orgListUserOrgs 3 params → 200404
GET
/users/{username}/orgs/{org}/permissions
Get user permissions in organization
orgGetUserPermissions 2 params → 200403404

Schemas 60

The contract defines 60 schemas that model the data the API accepts and returns. The most detailed are Repository (66 properties), User (23 properties), Activity (13 properties), Organization (12 properties). Each schema is shown below with its type and property counts.

Team
object
Team represents a team in an organization
9 properties
APIUnauthorizedError
object
2 properties
APIValidationError
object
2 properties
CreateTeamOption
object
CreateTeamOption options for creating a team
7 properties 1 required
OrganizationPermissions
object
OrganizationPermissions list different users permissions on an organization
5 properties
ExternalWiki
object
ExternalWiki represents setting for external wiki
1 property
QuotaUsedPackage
object
QuotaUsedPackage represents a package counting towards a user's quota
5 properties
QuotaUsedSizeGit
object
QuotaUsedSizeGit represents the size-based git (lfs) quota usage of a user
1 property
InternalTracker
object
InternalTracker represents settings for internal tracker
3 properties
QuotaUsedSizeAssetsPackages
object
QuotaUsedSizeAssetsPackages represents the size-based package quota usage of a user
1 property
EditLabelOption
object
EditLabelOption options for editing a label
5 properties
CreateOrUpdateSecretOption
object
1 property 1 required
CreateHookOption
object
CreateHookOption options when create a hook
6 properties 2 required
CreateHookOptionConfig
object
CreateHookOptionConfig has all config options in it required are "contenttype" and "url" Required
EditTeamOption
object
EditTeamOption options for editing a team
7 properties 1 required
Repository
object
Repository represents a repository
66 properties
User
object
User represents a user
23 properties
QuotaUsedPackageList
array
QuotaUsedPackageList represents a list of packages counting towards a user's quota
Activity
object
13 properties
QuotaUsedArtifactList
array
QuotaUsedArtifactList represents a list of artifacts counting towards a user's quota
APINotFound
object
3 properties
ActionRunner
object
ActionRunner represents a runner
10 properties
QuotaUsedAttachment
object
QuotaUsedAttachment represents an attachment counting towards a user's quota
4 properties
RegisterRunnerOptions
object
3 properties 1 required
CreateVariableOption
object
1 property 1 required
QuotaUsedSize
object
QuotaUsedSize represents the size-based quota usage of a user
3 properties
QuotaUsedArtifact
object
QuotaUsedArtifact represents an artifact counting towards a user's quota
3 properties
Hook
object
Hook a hook is a web hook when one repository changed
12 properties
QuotaGroup
object
QuotaGroup represents a quota group
2 properties
EditHookOption
object
EditHookOption options when modify one hook
5 properties
RegistrationToken
object
RegistrationToken is a string used to register a runner with a server
1 property
Organization
object
Organization represents an organization
12 properties
QuotaRuleInfo
object
QuotaRuleInfo contains information about a quota rule
3 properties
QuotaUsedAttachmentList
array
QuotaUsedAttachmentList represents a list of attachment counting towards a user's quota
Attachment
object
Attachment a generic attachment
8 properties
QuotaGroupList
array
QuotaGroupList represents a list of quota groups
CreateRepoOption
object
CreateRepoOption options when creating repository
12 properties 1 required
QuotaUsed
object
QuotaUsed represents the quota usage of a user
1 property
Secret
object
Secret represents a secret
2 properties
RepoTransfer
object
RepoTransfer represents a pending repo transfer
3 properties
QuotaUsedSizeAssetsAttachments
object
QuotaUsedSizeAssetsAttachments represents the size-based attachment quota usage of a user
2 properties
BlockedUser
object
2 properties
RenameOrgOption
object
RenameOrgOption options when renaming an organization
1 property 1 required
Permission
object
Permission represents a set of permissions
3 properties
APIForbiddenError
object
2 properties
UpdateUserAvatarOption
object
UpdateUserAvatarUserOption options when updating the user avatar
1 property
ActionRunJob
object
ActionRunJob represents a job of a run
11 properties
CreateOrgOption
object
CreateOrgOption options for creating an organization
8 properties 1 required
CreateLabelOption
object
CreateLabelOption options for creating a label
5 properties 2 required
ActionVariable
object
ActionVariable return value of the query API
4 properties
RegisterRunnerResponse
object
3 properties
QuotaUsedSizeAssets
object
QuotaUsedSizeAssets represents the size-based asset usage of a user
3 properties
QuotaInfo
object
QuotaInfo represents information about a user's quota
2 properties
Label
object
Label a label to an issue or a pr
7 properties
ExternalTracker
object
ExternalTracker represents settings for external tracker
4 properties
EditOrgOption
object
EditOrgOption options for editing an organization
7 properties
Comment
object
Comment represents a comment on a commit or issue
11 properties
QuotaUsedSizeRepos
object
QuotaUsedSizeRepos represents the size-based repository quota usage of a user
2 properties
APIError
object
APIError is an api error with a message
2 properties
UpdateVariableOption
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

forgejo-organization-api-openapi.yml Raw ↑

Other APIs Forgejo publishes across the network.

Forgejo activitypub API
Forgejo admin API
Forgejo issue API
Forgejo miscellaneous API
Forgejo notification API
Forgejo package API
Forgejo repository API
Forgejo settings API
Forgejo user API
Where this information came from

This is an independent, third-party profile of Forgejo organization API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.