Interface ProjectsParams

Query parameters accepted by GET /rest/api/latest/projects.

See

https://developer.atlassian.com/server/bitbucket/rest/v819/api-group-project/#api-api-latest-projects-get

interface ProjectsParams {
    limit?: number;
    name?: string;
    permission?: string;
    start?: number;
}

Hierarchy (View Summary)

Properties

limit? name? permission? start?

Properties

Optionallimit

limit?: number

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

Optionalname

name?: string

Filter by project name (case-insensitive prefix match)

Optionalpermission

permission?: string

Filter by the permission the authenticated user has on the project. e.g. 'PROJECT_READ', 'PROJECT_WRITE', 'PROJECT_ADMIN'

Optionalstart

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