Search users
Find users via various criteria. This method returns up to 100 results per page.
When searching for users, you can get text match metadata for the issue login, email, and name fields when you pass the text-match media type. For more details about highlighting search results, see Text match metadata. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you’re looking for a list of popular users, you might try this query:
q=tom+repos:%3E42+followers:%3E1000
This query searches for users with the name tom. The results are restricted to users with more than 42 repositories and over 1,000 followers.
get
http://HOSTNAME/api/v3/search/users
Query Parameters
qstringrequired
The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query. See “Searching users” for a detailed list of qualifiers.
sortstring
Sorts the results of your query by number of followers or repositories, or when the person joined GitHub Enterprise Server. Default: best match
Allowed values:followersrepositoriesjoined
orderstring
Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.
Allowed values:descasc
Default:desc
per_pageinteger
Results per page (max 100)
Default:30
pageinteger
Page number of the results to fetch.
Default:1
Response
application/json
Response
application/json
Response
total_countintegerrequired
incomplete_resultsbooleanrequired
itemsarray[object]required
User Search Result Item
Show Child Parameters
get/search/users
Query Parameters
application/json
teams
Interact with GitHub Teams.
List teams
Lists all teams in an organization that are visible to the authenticated user.
get
http://HOSTNAME/api/v3/orgs/{org}/teams
Query Parameters
per_pageinteger
Results per page (max 100)
Default:30
pageinteger
Page number of the results to fetch.
Default:1
Path Parameters
orgstringrequired
Response
application/json
Response
application/json
Response
Groups of organization members that gives permissions on specified repositories.
idintegerrequired
node_idstringrequired
namestringrequired
slugstringrequired
descriptionstring | nullrequired
privacystring
permissionstringrequired
permissionsobject
Show Child Parameters
urlstring(uri)required
html_urlstring(uri)required
Example:https://github.com/orgs/rails/teams/core
members_urlstringrequired
repositories_urlstring(uri)required
parentobject | nullrequired
Groups of organization members that gives permissions on specified repositories.
Show Child Parameters
get/orgs/{org}/teams
Path Parameters
Query Parameters
application/json
Create a team
To create a team, the authenticated user must be a member or owner of {org}. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see “Setting team creation permissions.”
When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of maintainers. For more information, see “About teams”.
post
http://HOSTNAME/api/v3/orgs/{org}/teams
Path Parameters
orgstringrequired
Body
application/json
Body
application/json
namestringrequired
The name of the team.
descriptionstring
The description of the team.
maintainersarray[string]
List GitHub IDs for organization members who will become team maintainers.
repo_namesarray[string]
The full name (e.g., “organization-name/repository-name”) of repositories to add the team to.
privacystring
The level of privacy this team should have. The options are:
For a non-nested team:
* secret - only visible to organization owners and members of this team.
* closed - visible to all members of this organization.
Default: secret
For a parent or child team:
* closed - visible to all members of this organization.
Default for child team: closed
Allowed values:secretclosed
permissionstring
Deprecated. The permission that new repositories will be added to the team with when none is specified. Can be one of:
* pull - team members can pull, but not push to or administer newly-added repositories.
* push - team members can pull and push, but not administer newly-added repositories.
Allowed values:pullpush
Default:pull
parent_team_idinteger
The ID of a team to set as the parent team.
ldap_dnstring
The distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the “Update LDAP mapping for a team” endpoint to change the LDAP DN. For more information, see “Using LDAP.”
Response
application/json
Response
application/json
Response
Full Team
Groups of organization members that gives permissions on specified repositories.
idintegerrequired
Unique identifier of the team
Example:42
node_idstringrequired
Example:MDQ6VGVhbTE=
urlstring(uri)required
URL for the team
Example:https://api.github.com/organizations/1/team/1
html_urlstring(uri)required
Example:https://github.com/orgs/rails/teams/core
namestringrequired
Name of the team
Example:Developers
slugstringrequired
Example:justice-league
descriptionstring | nullrequired
Example:A great team.
privacystring
The level of privacy this team should have
Allowed values:closedsecret
Example:closed
permissionstringrequired
Permission that the team will have for its repositories
Example:push
members_urlstringrequired
Example:https://api.github.com/organizations/1/team/1/members{/member}
repositories_urlstring(uri)required
Example:https://api.github.com/organizations/1/team/1/repos
parentobject | null
Groups of organization members that gives permissions on specified repositories.
Show Child Parameters
members_countintegerrequired
Example:3
repos_countintegerrequired
Example:10
created_atstring(date-time)required
Example:2017-07-14T16:53:42Z
updated_atstring(date-time)required
Example:2017-08-17T12:37:15Z
organizationobjectrequired
Organization Full
Show Child Parameters
ldap_dnstring
Distinguished Name (DN) that team maps to within LDAP environment
Example:uid=example,ou=users,dc=github,dc=com
post/orgs/{org}/teams
Path Parameters
Body
{
"name": "Justice League",
"description": "A great team",
"permission": "push",
"privacy": "closed"
}
application/json
Get a team by name
Gets a team using the team’s slug. GitHub Enterprise Server generates the slug from the team name.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}.
get
http://HOSTNAME/api/v3/orgs/{org}/teams/{team_slug}
Path Parameters
orgstringrequired
team_slugstringrequired
team_slug parameter
Response
application/json
Response
application/json
Response
Full Team
Groups of organization members that gives permissions on specified repositories.
idintegerrequired
Unique identifier of the team
Example:42
node_idstringrequired
Example:MDQ6VGVhbTE=
urlstring(uri)required
URL for the team
Example:https://api.github.com/organizations/1/team/1
html_urlstring(uri)required
Example:https://github.com/orgs/rails/teams/core
namestringrequired
Name of the team
Example:Developers
slugstringrequired
Example:justice-league
descriptionstring | nullrequired
Example:A great team.
privacystring
The level of privacy this team should have
Allowed values:closedsecret
Example:closed
permissionstringrequired
Permission that the team will have for its repositories
Example:push
members_urlstringrequired
Example:https://api.github.com/organizations/1/team/1/members{/member}
repositories_urlstring(uri)required
Example:https://api.github.com/organizations/1/team/1/repos
parentobject | null
Groups of organization members that gives permissions on specified repositories.
Show Child Parameters
members_countintegerrequired
Example:3
repos_countintegerrequired
Example:10
created_atstring(date-time)required
Example:2017-07-14T16:53:42Z
updated_atstring(date-time)required
Example:2017-08-17T12:37:15Z
organizationobjectrequired
Organization Full
Show Child Parameters
ldap_dnstring
Distinguished Name (DN) that team maps to within LDAP environment
Example:uid=example,ou=users,dc=github,dc=com
get/orgs/{org}/teams/{team_slug}
Path Parameters
application/json