List branches | Integrations | Northflank API docs
v1
ApplicationAPI & CLI
Double column
API
CLI
JS Client

Integrations /

List branches

Gets a list of branches for the repo

Required permission

Account > Git > General > Read

Path parameters

    • vcsService

      string required

      Version control provider of the repository

    • repositoryOwner

      string required

      Name of the owner of the repository

    • repositoryName

      string required

      Name of the repository

Query parameters

    • per_page

      integer

      The number of results to display per request. Maximum of 100 results per page.

    • page

      integer

      The page number to access.

    • cursor

      string

      The cursor returned from the previous page of results, used to request the next page.

Response body

  • {object}

    Response object.

    • data

      {object} required

      Result data.

      • per_page

        integer

        The number of results to display per request. Maximum of 100 results per page.

        min
        1
        max
        100

      • page

        integer

        The page number to access.

        min
        1

      • cursor

        string

        The cursor returned from the previous page of results, used to request the next page.

        min length
        24
        max length
        24

    • pagination

      {object} required

      Data about the endpoint pagination.

      • hasNextPage

        boolean required

        Is there another page of results available?

      • cursor

        string

        The cursor to access the next page of results.

      • count

        number required

        The number of results returned by this request.

API
CLI
JS Client

GET /v1/integrations/vcs/repos/{vcsService}/{repositoryOwner}/{repositoryName}/branches

Example response

200 OK

The list of branches.

JSON

{
  "data": {
    "per_page": 50,
    "page": 1
  },
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}

© 2024 Northflank Ltd. All rights reserved.

northflank.comTermsPrivacyfeedback@northflank.com