GitHub Search

GitHub Search

Certified

Search users

Runs a GitHub user search and writes matching user metadata to Kestra internal storage. Anonymous execution skips private data and may omit fields, and authenticated runs default to JOINED sorted in ascending order.

yaml
type: io.kestra.plugin.github.users.Search

Search for users.

yaml
id: github_user_search_flow
namespace: company.team

tasks:
  - id: search_users
    type: io.kestra.plugin.github.users.Search
    oauthToken: "{{ secret('GITHUB_ACCESS_TOKEN') }}"
    query: "kestra-io in:login language:java"

Search for users with conditions.

yaml
id: github_user_search_flow
namespace: company.team

tasks:
  - id: search_users
    type: io.kestra.plugin.github.users.Search
    oauthToken: "{{ secret('GITHUB_ACCESS_TOKEN') }}"
    query: kestra-io
    in: login
    language: java
Properties
Possible Values
USERORGANIZATION

Account type

USER returns individual accounts and ORGANIZATION returns organization accounts

GitHub App installation token

Installation access token generated by a GitHub App. Use this for repository-scoped app access instead of a user token.

Joined date filter

Supports >, <, and range (..) syntax with YYYY-MM-DD

GitHub API endpoint

GitHub or GitHub Enterprise API base URL such as https://api.github.com or https://ghe.acme.com/api/v3. Set this when targeting GitHub Enterprise or a non-default API endpoint.

DefaultSTORE
Possible Values
STOREFETCHFETCH_ONENONE

Result handling mode

Controls how hits are exposed in outputs; default FETCH returns all hits in the response. FETCH_ONE returns only the first hit, STORE writes hits to Kestra storage and returns a URI, and NONE leaves outputs empty.

Followers filter

Supports >, <, and range (..) follower counts

Fields to search (in: )

Restricts the search to fields accepted by GitHub such as login, fullname, or email

GitHub JWT token

GitHub App JWT used for app-level authentication. Use this when the task should authenticate as the app rather than a user.

Language filter

Language name or alias applied to repositories the user owns

Location filter

Matches the public profile location field

GitHub login

GitHub login used with oauthToken for authenticated requests. Leave unset when authenticating with jwtToken or appInstallationToken.

GitHub OAuth token

GitHub personal access token used for authenticated requests. Can be used alone or with login.

DefaultASC
Possible Values
ASCDESC

Sort direction

ASC sorts ascending (default); DESC sorts descending.

Reference (ref) of the pluginDefaults to apply to this task.

Search keywords and qualifiers

User search syntax combining keywords with qualifiers like location, followers, language.

Repository count filter

Exact repository count to match

DefaultJOINED
Possible Values
JOINEDREPOSITORIESFOLLOWERS

Sort field

JOINED sorts by join date (default); REPOSITORIES by public repo count; FOLLOWERS by follower count.

First hit

Available only when fetchType=FETCH_ONE; contains the first hit source.

SubTypeobject

Fetched hits

Available only when fetchType=FETCH; contains hit sources for the current response page.

Returned hit count

Number of hits included in outputs for the selected fetch type.

Total hits reported

Total hits reported by GitHub search, regardless of pagination.

Formaturi

Stored hits URI

Available only when fetchType=STORE; Kestra internal storage path to the Ion file.

More Plugins in this Category

Zulip
Zulip

Tasks that send messages to Zulip streams or users.

Business

2 tasks

3 blueprints

OPA (Open Policy Agent)
OPA (Open Policy Agent)
Enterprise

Tasks to manage Open Policy Agent policies and decisions, including upload, evaluation, and partial evaluation.

Infrastructure

5 tasks

3 blueprints