Get

Learn how to list repos by current user or by organization.

Endpoint

GET  /api/v1/repos

This will return a list of all repos owned by the user.

Filters

The following optional filters are available:

Name	Description
`page`	page number for results (default 1)
`per_page`	number of results in a page (default 10, max 100)

Permissions

COMING SOON!

Responses

Status Code	Description
`200`	indicates the request has succeeded
`401`	indicates the user does not have proper permissions

Sample

This section assumes you already know how to authenticate to the API.

To authenticate to the API, please review the authentication documentation.

Request

curl \
  -X GET \
  -H "Authorization: Bearer <token>" \
  "http://127.0.0.1:8080/api/v1/repos"

Response

[
  {
    "id": 1,
    "user_id": 1,
    "org": "github",
    "name": "octocat",
    "full_name": "github/octocat",
    "link": "https://github.com/github/octocat",
    "clone": "https://github.com/github/octocat.git",
    "branch": "main",
    "build_limit": 10,
    "timeout": 60,
    "counter": 0,
    "visibility": "public",
    "private": false,
    "trusted": true,
    "active": true,
    "allow_pull": true,
    "allow_push": true,
    "allow_deploy": false,
    "allow_tag": false,
    "allow_comment": false,
    "allow_events": {
      "push": {
        "branch": true,
        "tag": true,
        "delete_branch": false,
        "delete_tag": false
      },
      "pull_request": {
        "opened": false,
        "edited": false,
        "synchronize": false,
        "reopened": false,
        "labeled": false,
        "unlabeled": false
      },
      "deployment": {
        "created": true
      },
      "comment": {
        "created": false,
        "edited": false
      },
      "schedule": {
        "run": false
      }
    },
    "pipeline_type": "yaml"
  },
  {
    "id": 2,
    "user_id": 1,
    "org": "github",
    "name": "octokitty",
    "full_name": "github/octokitty",
    "link": "https://github.com/github/octokitty",
    "clone": "https://github.com/github/octokitty.git",
    "branch": "main",
    "build_limit": 10,
    "timeout": 60,
    "counter": 0,
    "visibility": "public",
    "private": false,
    "trusted": true,
    "active": true,
    "allow_pull": true,
    "allow_push": true,
    "allow_deploy": false,
    "allow_tag": false,
    "allow_comment": false,
    "allow_events": {
      "push": {
        "branch": true,
        "tag": true,
        "delete_branch": false,
        "delete_tag": false
      },
      "pull_request": {
        "opened": false,
        "edited": false,
        "synchronize": false,
        "reopened": false,
        "labeled": false,
        "unlabeled": false
      },
      "deployment": {
        "created": true
      },
      "comment": {
        "created": false,
        "edited": false
      },
      "schedule": {
        "run": false
      }
    },
    "pipeline_type": "yaml"
  }
]