v2
latestOpenAPI 3.0.1private2026-07-2667209320.4 KBOrganizations
List Members
List Members
List this organization's members.
Returns a paginated list of StackHawk Users.
User
A StackHawk User as identified by the platform.
| Parameter | Default | Description |
|---|---|---|
| stackhawkId | "" | An internal identifier for this user. This is not the user uuid. |
| provider | {} | Information about the login provider assigned to this user. Read More |
| external | {} | Information about the user itself, and how they appear in the platform. Read More |
| createdTimestamp | 0 | Creation timestamp of this user. |
UserOrganization
Represents the relationship between a User and an Organization they belong to.
| Parameter | Default | Description |
|---|---|---|
| organization | {} | The StackHawk organization this user belongs to. |
| role | "UNKNOWN" | The organization role the user belongs to within this organization. |
| features | [] | Specific access features available to this organization. |
| metadata | [] | The user's organizational specific metadata. |
| achievements | [] | Specific product journey events that have triggered for this user. |
| permissions | [] | Permissions the User has in this organization. |
| Parameter | Description |
|---|---|
| UNKNOWN | null |
| OWNER | null |
| ADMIN | null |
| MEMBER | null |
| TEAM_ADMIN | null |
| VIEW_ONLY | null |
| SCAN_ONLY_SERVICE_ACCOUNT | null |
Organization
A StackHawk Organization.
| Parameter | Default | Description |
|---|---|---|
| id | "" | The UUID identifier of this StackHawk Organization. |
| name | "" | The name of this Organization. |
| subscription | {} | The billing subscription of this Organization. |
| isLinkedToExternalBilling | false | If this organization is yet connected to external billing (Stripe). |
| plan | "" | The feature plan this organization belongs to. |
| features | [] | Specific overrides to the feature flags in the plan. |
| settings | {} | Organization settings. |
| createdTimestamp | 0 | Creation timestamp of this organization. |
A StackHawk platform user can belong to many organizations.
Requires read:member permission.
get/api/v1/org/{orgId}/members
Path parameters
orgIdstring uuid required
UUID identifier for this StackHawk Organization.
Query parameters
pageSizeinteger
Pagination response size limit.
pageTokeninteger
Pagination request page increment.
sortField'id'
Resource field to sort paginated response by.
sortDir'asc' | 'desc'
Paginated results are sorted 'asc' or 'desc'.
patternstring
Filter users by name or email (case-insensitive search).
rolesstring[]
Filter users by organization roles (comma-separated list of OWNER, ADMIN, MEMBER).
Response
A paginated response of StackHawk Users.