Get All Sub-Organization Members

Retrieves a list of all users (admins and members) within a specific sub-organization. The response includes user names, emails, and their roles in the sub-organization.

HTTP Method and URL

Method: GET
URL: {{host}}/api/v2/sub-organizations/:subOrganizationUuid/members?user_type=ENTERPRISE_API

Authentication Requirements

• Requires a valid Bearer token in the Authorization header ({USER-TOKEN}).

• Ensure the token has permission to access sub-organization member data.

Path and Query Parameters

Path Parameter:

• subOrganizationUuid (string, required): The unique identifier of the sub-organization.

Query Parameter:

• user_type (string, required): Must be set to ENTERPRISE_API.

Request Body

This endpoint does not require a request body.

Example Request

GET {{host}}/api/v2/sub-organizations/dcd384fd-62e3-481f-8cff-6eda0e90c944/members?user_type=ENTERPRISE_API
Authorization: Bearer {USER-TOKEN}
Content-Type: application/json

Example Successful Response

[
  {
    "name": "Jane Doe",
    "email": "[email protected]",
    "role": "admin"
  },
  {
    "name": "John Smith",
    "email": "[email protected]",
    "role": "member"
  }
]

Error Responses

• 401 Unauthorized: Missing or invalid authentication token.

• 403 Forbidden: Insufficient permissions to access sub-organization members.

• 404 Not Found: Sub-organization not found.

• 400 Bad Request: Missing or invalid parameters.

Usage Notes

• Only users with appropriate permissions can access this endpoint.

• The user_type query parameter must be set to ENTERPRISE_API.

• The endpoint returns both admins and members of the specified sub-organization.