GIgitea
repository

Search for repositories

Changed on
get/repos/search

Request

  • Base URL
    https://demo.gitea.com/api/v1
  • Auth
    • HTTP basic
    • or API key in query parameter token
    • or API key in query parameter access_token
    • or API key in header Authorization
    • or API key in query parameter sudo
    • or API key in header Sudo
    • or API key in header X-GITEA-OTP
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

qstring

keyword

topicboolean

Limit search to repositories with keyword as topic

includeDescboolean

include search of keyword within repository description

uidinteger

search only for repos that the user with the given id owns or contributes to

priority_owner_idinteger

repo owner to prioritize in the results

team_idinteger

search only for repos that belong to the given team id

starredByinteger

search only for repos that the user with the given id has starred

privateboolean

include private repositories this user has access to (defaults to true)

is_privateboolean

show only pubic, private or all repositories (defaults to all)

templateboolean

include template repositories this user has access to (defaults to true)

archivedboolean

show only archived, non-archived or all repositories (defaults to all)

modestring

type of repository to search for. Supported values are "fork", "source", "mirror" and "collaborative"

exclusiveboolean

if uid is given, search only for repos that the user owns

sortstring

sort repos by attribute. Supported values are "alpha", "created", "updated", "size", "git_size", "lfs_size", "stars", "forks" and "id". Default is "alpha"

orderstring

sort order, either "asc" (ascending) or "desc" (descending). Default is "asc", ignored if "sort" is not specified.

pageinteger

page number of results to return (1-based)

limitinteger

page size of results

Response

SearchResults

okboolean

OK indicates if the search was successful

Example response

{
  "data": [
    {
      "repo_transfer": {
        "teams": [
          {
            "units": [
              "repo.code",
              "repo.issues",
              "repo.ext_issues",
              "repo.wiki",
              "repo.pulls",
              "repo.releases",
              "repo.projects",
              "repo.ext_wiki"
            ],
            "units_map": {
              "repo.code": "read",
              "repo.ext_issues": "none",
              "repo.ext_wiki": "none",
              "repo.issues": "write",
              "repo.projects": "none",
              "repo.pulls": "owner",
              "repo.releases": "none",
              "repo.wiki": "admin"
            }
          }
        ]
      }
    }
  ]
}

Changes