List Family Members
Lists every person with access anywhere in the family and where that access comes from: members of the primary (who inherit access to every sub-workspace) and people added directly to one or more sub-workspaces.
GET
List Family Members
List everyone with access anywhere in the family and where that access comes from. Members of the primary inherit access to every sub-workspace; people added directly to a sub-workspace see only that sub-workspace.
When to use
- Access audits across all client or team workspaces.
- Showing who can reach a given sub-workspace in your own admin tool.
Reading the response
scopeisprimaryfor members of the primary (they have inherited access to every current and future sub-workspace) andsubfor people added only to sub-workspaces.sub_workspace_idslists direct sub-workspace memberships only. Inherited access is not repeated there.permissions_by_workspacegives the effective permissions per workspace id, inherited rows included, so you can render access without re-deriving it.invite_statusissuccessorpending.
Integration notes
- Authenticate with the primary workspace’s API key.
- To add or remove people, use the workspace member endpoints against the relevant workspace; this endpoint is read-only.
Error responses
- 400:
Sub-workspaces cannot have their own sub-workspaces.— the key belongs to a sub-workspace. - 401: Invalid or missing API key.
- 403:
Sub-workspaces are not enabled for this workspace.
Example
Headers
(Required) The API key of the PRIMARY workspace. A sub-workspace's key is refused with 400.
Example:
"7251cb4b-3373-43a4-844c-b27a1d45e0c9"