> ## Documentation Index > Fetch the complete documentation index at: https://docs.bridgly.app/llms.txt > Use this file to discover all available pages before exploring further. # Search GitHub users and organizations ## OpenAPI ````yaml /openapi.json post /github/search-users openapi: 3.1.0 info: title: Bridgly API description: >- Web scraping API for LinkedIn, X (Twitter) and Reddit. Authenticated endpoints accept a Bridgly API key (`bgly_…`) via `Authorization: Bearer `. version: 1.0.0 servers: - url: https://api.bridgly.app description: Production security: [] tags: - name: LinkedIn description: Scrape LinkedIn profiles, companies, posts, and search. - name: Reddit description: Scrape Reddit posts, subreddits, users, and search. - name: X (Twitter) description: Scrape tweets and search X. - name: GitHub description: >- Fetch GitHub profiles, pinned repos, contributions, repositories, stars, and projects via GitHub's GraphQL API. paths: /github/search-users: post: tags: - GitHub summary: Search GitHub users and organizations requestBody: required: true content: application/json: schema: type: object properties: query: description: >- Free-text search terms, matched against the default fields for this search type, e.g. "web framework". type: string type: description: Restrict to users or organizations. Maps to `type:`. type: string enum: - user - org fullName: description: >- Match a display name, e.g. "Grace Hopper". Maps to `fullname:`. type: string location: description: Profile location, e.g. "San Francisco". Maps to `location:`. type: string language: description: Users who code in this language. Maps to `language:`. type: string followers: description: >- Filter by follower count. Provide any of gt / gte / lt / lte; combine a lower and upper bound for a range. type: object properties: gt: description: Strictly greater than this value. anyOf: - type: number - type: 'null' gte: description: Greater than or equal to this value. anyOf: - type: number - type: 'null' lt: description: Strictly less than this value. anyOf: - type: number - type: 'null' lte: description: Less than or equal to this value. anyOf: - type: number - type: 'null' repos: description: >- Filter by public repository count. Provide any of gt / gte / lt / lte; combine a lower and upper bound for a range. type: object properties: gt: description: Strictly greater than this value. anyOf: - type: number - type: 'null' gte: description: Greater than or equal to this value. anyOf: - type: number - type: 'null' lt: description: Strictly less than this value. anyOf: - type: number - type: 'null' lte: description: Less than or equal to this value. anyOf: - type: number - type: 'null' created: description: >- Filter by account creation date. Provide any of gt / gte / lt / lte as YYYY-MM-DD dates; combine a lower and upper bound for a range. type: object properties: gt: description: Strictly after this date (YYYY-MM-DD). anyOf: - type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ - type: 'null' gte: description: On or after this date (YYYY-MM-DD). anyOf: - type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ - type: 'null' lt: description: Strictly before this date (YYYY-MM-DD). anyOf: - type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ - type: 'null' lte: description: On or before this date (YYYY-MM-DD). anyOf: - type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ - type: 'null' sort: default: best-match description: Sort field. Defaults to relevance ("best-match"). type: string enum: - best-match - followers - repositories - joined order: default: desc description: Sort direction. Defaults to "desc". type: string enum: - desc - asc count: default: 10 description: Number of results per page (1–10). Defaults to 10. type: integer minimum: 1 maximum: 10 after: description: >- Pagination cursor (the `after` value returned by a previous page). Omit for the first page. type: string responses: '200': description: Default Response content: application/json: schema: type: object properties: timeMs: type: number description: >- Wall-clock time the request took to complete, in milliseconds. creditsCost: type: number description: Number of account credits this request consumed. data: type: object properties: query: type: string description: The compiled GitHub search query string that was run. totalCount: anyOf: - type: number - type: 'null' description: >- Total matches GitHub reports (approximate, and capped at 1000 results). users: type: array items: type: object properties: id: type: string description: User/Org GraphQL node id. type: anyOf: - type: string - type: 'null' description: '"User" or "Organization".' username: anyOf: - type: string - type: 'null' description: Login (username or org name). name: anyOf: - type: string - type: 'null' description: Display name, or null. bio: anyOf: - type: string - type: 'null' description: Profile bio / description, or null. avatarUrl: anyOf: - type: string - type: 'null' description: URL of the avatar image. url: anyOf: - type: string - type: 'null' description: Public profile URL. location: anyOf: - type: string - type: 'null' description: Profile location, or null. followersCount: anyOf: - type: number - type: 'null' description: Follower count (null for organizations). repositoriesCount: anyOf: - type: number - type: 'null' description: Public repository count. required: - id - type - username - name - bio - avatarUrl - url - location - followersCount - repositoriesCount additionalProperties: false description: Users and organizations matching this page. after: anyOf: - type: string - type: 'null' description: >- Pagination cursor for the next page (GitHub `endCursor`), or null when there are no more results. required: - query - totalCount - users - after additionalProperties: false required: - timeMs - creditsCost - data additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: status: type: string enum: - error message: type: string description: Human-readable description of what went wrong. required: - status - message additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: status: type: string enum: - error message: type: string description: Human-readable description of what went wrong. required: - status - message additionalProperties: false '402': description: Default Response content: application/json: schema: type: object properties: status: type: string enum: - error message: type: string description: Human-readable description of what went wrong. required: - status - message additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: status: type: string enum: - error message: type: string description: Human-readable description of what went wrong. required: - status - message additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: status: type: string enum: - error message: type: string description: Human-readable description of what went wrong. required: - status - message additionalProperties: false security: - bearerAuth: [] x-codeSamples: - lang: typescript label: Bridgly SDK source: |- import { Bridgly } from 'bridgly'; const client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY }); const res = await client.github.searchUsers({ sort: "best-match", order: "desc", count: 10, }); if (res.type === 'success') console.log(res.data); components: securitySchemes: bearerAuth: type: http scheme: bearer description: >- A Bridgly API key (`bgly_…`). Metered endpoints deduct credits from the resolved account. ````