Interface SearchUsersParams

Query parameters accepted by GET /search/users.

See

https://docs.github.com/en/rest/search/search#search-users

interface SearchUsersParams {
    order?: "asc" | "desc";
    page?: number;
    per_page?: number;
    q: string;
    sort?: "followers" | "repositories" | "joined";
}

Hierarchy (View Summary)

Properties

order? page? per_page? q sort?

Properties

Optionalorder

order?: "asc" | "desc"

Sort direction

Optionalpage

page?: number

Page number to retrieve (1-based). Use nextPage from the previous response to paginate forward.

Optionalper_page

per_page?: number

Maximum number of results per page. GitHub default is 30, maximum is 100.

q

q: string

Search query (required)

Optionalsort

sort?: "followers" | "repositories" | "joined"

Sort field

Settings

Member Visibility

On This Page

Properties