StackHawk Documentation StackHawk Logo HawkDocs
api
organization teams
list teams for org

No results found

Try different keywords or check your spelling

Search documentation

Find guides, API references, and more

↑ ↓ ↵ esc

Find Teams for Organization

GET /api/v1/org/{orgId}/teams

List Teams

Get the Teams that belong to this StackHawk organization.

Returns a paginated list of Teams.

Parameter Default Description
teams [] found list of teams.
nextPageToken "" pageToken to provide for the next page of results.
totalCount 0 total number of results.

All users that belong to this organization can call this endpoint.

Requires read:team permission.

Path parameters

orgIdstring · uuidrequired

UUID identifier for this StackHawk Organization.

Query parameters

pageTokeninteger · int32

Pagination request page increment.

default: 0
pageSizeinteger · int32

Pagination response size limit.

default: 10
searchstring

Filter teams by name pattern.

Response

Paginated response of teams.

nextPageToken
string

pageToken to provide for the next page of results.

teams
organization.Team[]

found list of teams.

Hide child attributesShow child attributes
teams.applications
organization.TeamApplication[]

The applications that belong to this Team.

Hide child attributesShow child attributes
teams.applications.applicationId
string
teams.applications.applicationName
string
teams.applications.environments
string[]
teams.applications.lastScanTimestamp
integer<int64>
teams.id
string

The UUID identifier of this team.

teams.name
string

The name of this team.

teams.organizationId
string

The StackHawk organization that owns this Team.

teams.users
organization.TeamUser[]

The users that are members of this Team.

Hide child attributesShow child attributes
teams.users.email
string
teams.users.role
string
teams.users.userId
string
teams.users.userName
string
totalCount
integer<int64>

total number of results.

nextPageToken
string

pageToken to provide for the next page of results.

teams
organization.Team[]

found list of teams.

Hide child attributesShow child attributes
teams.applications
organization.TeamApplication[]

The applications that belong to this Team.

Hide child attributesShow child attributes
teams.applications.applicationId
string
teams.applications.applicationName
string
teams.applications.environments
string[]
teams.applications.lastScanTimestamp
integer<int64>
teams.id
string

The UUID identifier of this team.

teams.name
string

The name of this team.

teams.organizationId
string

The StackHawk organization that owns this Team.

teams.users
organization.TeamUser[]

The users that are members of this Team.

Hide child attributesShow child attributes
teams.users.email
string
teams.users.role
string
teams.users.userId
string
teams.users.userName
string
totalCount
integer<int64>

total number of results.

Unauthorized

Your privacy settings

We use first and third party cookies to ensure that we give you the best experience on our website and in our products.

Privacy Policy