Bitbucket Data Center API Client
    Preparing search index...

    Interface BranchesParams

    Query parameters accepted by GET /rest/api/latest/projects/{key}/repos/{slug}/branches.

    https://developer.atlassian.com/server/bitbucket/rest/v819/api-group-repository/#api-api-latest-projects-projectkey-repos-repositoryslug-branches-get

    interface BranchesParams {
        base?: string;
        boostMatches?: boolean;
        details?: boolean;
        filterText?: string;
        limit?: number;
        orderBy?: "ALPHABETICAL" | "MODIFICATION";
        start?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    base? boostMatches? details? filterText? limit? orderBy? start?

    Properties

    base?: string

    Base branch or commit to use for ahead/behind comparisons when details is true

    boostMatches?: boolean

    Boost exact matches to the top of the results when filtering

    details?: boolean

    Include branch metadata such as ahead/behind counts relative to base

    filterText?: string

    Filter branches by name (prefix match)

    limit?: number

    Maximum number of results to return per page. Bitbucket default is 25, maximum is 1000.

    orderBy?: "ALPHABETICAL" | "MODIFICATION"

    Sort order of results

    start?: number

    0-based index of the first result to return. Use nextPageStart from the previous response to paginate forward.

    Settings

    Member Visibility

    On This Page

    Properties