Search for teams within an organization

GET

/orgs/{org}/teams/search

Authorizations

• BasicAuth
• AuthorizationHeaderToken
• SudoParam
• SudoHeader
• TOTPHeader

Parameters

Path Parameters

org

required

string

Name of the organization

Query Parameters

q

string

Keywords to search

include_desc

boolean

Include search within team description (defaults to true)

page

integer

Page number of results to return (1-based)

limit

integer

Page size of results

Responses

200

SearchResults of a successful search

Media type application/json

TeamSearchResults

object

data

Array<object>

Team represents a team in an organization

object

can_create_org_repo

boolean

description

string

id

integer format: int64

includes_all_repositories

boolean

name

string

organization

Organization represents an organization

object

avatar_url

string

created

string format: date-time

description

string

email

string

full_name

string

id

integer format: int64

location

string

name

string

repo_admin_change_team_access

boolean

username

Deprecated

string

visibility

string

website

string

permission

string

Allowed values: none read write admin owner

units

Array<string>

units_map

object

key

additional properties

string

ok

boolean

Example

{
  "data": [
    {
      "permission": "none",
      "units": [
        "repo.code",
        "repo.issues",
        "repo.ext_issues",
        "repo.wiki",
        "repo.pulls",
        "repo.releases",
        "repo.projects",
        "repo.ext_wiki"
      ],
      "units_map": {
        "repo.actions": "none",
        "repo.code": "read",
        "repo.ext_issues": "none",
        "repo.ext_wiki": "none",
        "repo.issues": "write",
        "repo.packages": "none",
        "repo.projects": "none",
        "repo.pulls": "owner",
        "repo.releases": "none",
        "repo.wiki": "admin"
      }
    }
  ]
}

404

APINotFound is a not found error response

Media type application/json

object

errors

Array<string>

message

string

url

string

Example ^generated

{
  "errors": [
    "example"
  ],
  "message": "example",
  "url": "example"
}