v2

latestOpenAPI 3.0.1private2026-07-2667209320.4 KB
Applications

List Applications - V2

List Applications V2

Lists applications that belong to this organization.

Returns a new style paginated list of Applications.

ParameterDefaultDescription
orgId""The org id that these applications belong to.
applications[]List of applications.
totalCount0Total number of applications in the results.
currentPage{}The current page.
hasNextfalseWhether or not there is a next page.
nextPage{}
nextPageToken""
hasPrevfalseWhether or not there is a previous page.
prevPage{}
prevPageToken""

Application

Applications group scan results from HawkScan, and coordinate settings to influence HawkScan behavior. The application may also contain a specific environment name and id. For more information, see Applications.

ParameterDefaultDescription
applicationId""The UUID identifier of this application.
name""The name of this application.
env""The name of this environment. Only set when requesting Application Environments.
envId""The UUID identifier of this environment.
applicationStatus"ACTIVE"The status of this application. Either ACTIVE or ENV_INCOMPLETE.
organizationId""The UUID identifier of the organization that owns this application.
applicationType"STANDARD"The type of this application.
cloudScanTarget{}Optional Cloud Scan Target configuration.

The returned list of applications is filtered by the organization id and User's API Token Team membership.

Filter Query Params

  • query: A string to filter applications by name.
  • appIds: A comma-separated list of application uuids to filter by.
  • teamIds: A comma-separated list of team uuids to filter by.
  • applicationStatus: A comma-separated list of application statuses to filter by. Possible values are ACTIVE and ENV_INCOMPLETE.

Requires read:application permission.

get/api/v2/org/{orgId}/apps

Path parameters

orgIdstring uuid required

UUID identifier for this StackHawk Organization.

Query parameters

querystring

A term used to filter results based on matching content in one or more fields.

sortField'applicationId' | 'applicationName' | 'applicationStatus' | 'mappedRepositoryCount' | 'thirtyDayCommitActivity'

Resource field to sort paginated response by.

sortDir'ASC' | 'DESC' | 'UNSORTED'

Paginated results are sorted 'asc' or 'desc'.

pagestring

Pagination page key.

pageSizeinteger

Pagination response size limit.

pageTokeninteger

Pagination request page increment.

appIdsstring[]

A comma-delimited list of UUID identifiers of StackHawk Applications.

teamIdsstring[]

A comma-delimited list of UUID identifiers of StackHawk Teams to filter by.

applicationStatusstring[]

A comma-separated list of application status filters.

applicationTypesstring[]

A comma-separated list of ApplicationType names.

Response

Paginated response of applications.

hasNextboolean

Whether or not there is a next page.

hasPrevboolean

Whether or not there is a previous page.

nextPageTokenstring
orgIdstring

The org id that these applications belong to.

prevPageTokenstring
totalCountinteger

Total number of applications in the results.