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

Gogs Users API

Search users, manage access tokens, emails, followers, and public keys

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

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 21 operations across 14 paths, and defines 4 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://gogs.example.com/api/v1.

21 operations 14 paths 4 schemas 3 DELETE14 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Server
https://gogs.example.com/api/v1
Authentication
HTTP Basic, API Key
Resource Areas
1

Authentication & Security 2

Gogs Users API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (BasicAuth). An API key is passed in the header as Authorization (AccessToken). By default, every request must be authenticated.

  • AccessToken — Personal access token. Use format: token {YOURACCESSTOKEN}

Paths & Operations 21

Across 14 paths, the API surfaces 21 operations — 3 DELETE, 14 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Users 21

Search users, manage access tokens, emails, followers, and public keys

GET
/users/search
Search for users
searchUsers 2 params → 200
GET
/users/{username}
Get a single user
getUser 1 param → 200404
GET
/user
Get the authenticated user
getAuthenticatedUser → 200
GET
/users/{username}/tokens
List access tokens
listAccessTokens 1 param → 200404
POST
/users/{username}/tokens
Create an access token
createAccessToken 1 param body → 201404422
GET
/user/emails
List email addresses
listEmails → 200
POST
/user/emails
Add email addresses
addEmails body → 200422
DELETE
/user/emails
Delete email addresses
deleteEmails body → 204
GET
/users/{username}/followers
List followers of a user
listUserFollowers 1 param → 200404
GET
/user/followers
List your followers
listMyFollowers → 200
GET
/users/{username}/following
List users followed by a user
listUserFollowing 1 param → 200404
GET
/user/following
List who you are following
listMyFollowing → 200
GET
/user/following/{target}
Check if you follow a user
checkFollowing 1 param → 204404
PUT
/user/following/{target}
Follow a user
followUser 1 param → 204404422
DELETE
/user/following/{target}
Unfollow a user
unfollowUser 1 param → 204404
GET
/users/{username}/following/{target}
Check if a user follows another
checkUserFollowing 2 params → 204404
GET
/users/{username}/keys
List public keys for a user
listUserKeys 1 param → 200404
GET
/user/keys/{id}
Get a single public key
getPublicKey 1 param → 200404
DELETE
/user/keys/{id}
Delete a public key
deletePublicKey 1 param → 204404
GET
/user/keys
List your public keys
listMyKeys → 200
POST
/user/keys
Create a public key
createPublicKey body → 201422

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are User (6 properties), PublicKey (5 properties), Email (3 properties), AccessToken (2 properties). Each schema is shown below with its type and property counts.

Email
object
3 properties
User
object
6 properties
AccessToken
object
2 properties
PublicKey
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gogs-users-api-openapi.yml Raw ↑

Other APIs Gogs publishes across the network.

Gogs API
Gogs Administration API
Gogs Collaborators and Deploy Keys API
Gogs Issues API
Gogs Miscellaneous API
Gogs Organizations API
Gogs Releases API
Gogs Repositories API
Gogs Webhooks API
Where this information came from

This is an independent, third-party profile of Gogs Users 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.