Search

yaml

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

Search for GitHub users.

If no authentication is provided, anonymous authentication will be used. Anonymous authentication can't retrieve full information.

Examples

Search for users.

yaml

id: github_user_search_flow
namespace: company.team

tasks:
  - id: search_users
    type: io.kestra.plugin.github.users.Search
    oauthToken: your_github_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: your_github_token
    query: kestra-io
    in: login
    language: java

Properties

`accountType`

Type: string
Dynamic: ✔️
Required: ❌
Possible Values:
- USER
- ORGANIZATION

Restrict search results to personal accounts or organizations only.

USER - the results will include only user accounts

ORGANIZATION - the results will include only organization accounts

`created`

Type: string
Dynamic: ✔️
Required: ❌

Filter users based on when they joined GitHub.

Available formats:

'<=YYYY-MM-DD' - joined at or before
'>=YYYY-MM-DD' - joined at or after
Similar cases for above two with ">", "<"
'YYYY-MM-DD..YYYY-MM-DD' - joined in period between

`followers`

Type: string
Dynamic: ✔️
Required: ❌

Filter users based on the number of followers that they have.

`in`

Type: string
Dynamic: ✔️
Required: ❌

With the 'in' qualifier you can restrict your search to the username/login, full name, public email.

Example kenya in:login matches users with the word "kenya" in their username. One more case of use to search users that have sponsor profile, equivalent to query: is:sponsorable.