List repositories

Returns a paginated list of repositories indexed by this Sourcebot instance.

GET /api/repos

List repositories

cURL

curl --request GET \
  --url https://api.example.com/api/repos \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.example.com/api/repos"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/api/repos', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/repos",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/repos"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/api/repos")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/repos")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

[
  {
    "repoId": 123,
    "repoName": "<string>",
    "webUrl": "<string>",
    "isFork": true,
    "isArchived": true,
    "repoDisplayName": "<string>",
    "externalWebUrl": "<string>",
    "imageUrl": "<string>",
    "indexedAt": "<string>",
    "pushedAt": "<string>",
    "defaultBranch": "<string>"
  }
]

{
  "statusCode": 123,
  "errorCode": "<string>",
  "message": "<string>"
}

{
  "statusCode": 123,
  "errorCode": "<string>",
  "message": "<string>"
}

Authorizations

bearerTokenapiKeyHeader

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your API key.

Query Parameters

page · integer · default: 1

Required range: x > 0

perPage · integer · default: 30

Required range: 0 < x <= 100

sort · enum<string> · default: name

Available options: name, pushed

direction · enum<string> · default: asc

Available options: asc, desc

query · string

Response

200

application/json

Paginated repository list.

codeHostType · enum<string> · required

Available options: github, gitlab, gitea, gerrit, bitbucketServer, bitbucketCloud, genericGitHost, azuredevops

repoId · number · required

repoName · string · required

webUrl · string · required

isFork · boolean · required

isArchived · boolean · required

repoDisplayName · string

externalWebUrl · string

imageUrl · string

indexedAt · string | null

pushedAt · string | null

defaultBranch · string