Get Organization Members

This endpoint retrieves a list of all users (owner, admins, and members) inside the main organization of the specified user type. It lists their names, emails, and organization roles.

HTTP Method and URL

GET {{host}}/api/v2/organization/members?user_type=ENTERPRISE_API

Authentication Requirements

Requires a valid user token. Pass the token using the user-token variable in the request headers or as required by your API setup.

Path and Query Parameters

• user_type (query, required): The type of users to retrieve. Example: ENTERPRISE_API

Request Body

This request does not require a body.

Example Request

GET {{host}}/api/v2/organization/members?user_type=ENTERPRISE_API
Headers:
  user-token: <your_token>

Example Successful Response

{
  "members": [
    {
      "id": "12345",
      "name": "Jane Doe",
      "email": "[email protected]",
      "user_type": "ENTERPRISE_API"
    },
    {
      "id": "67890",
      "name": "John Smith",
      "email": "[email protected]",
      "user_type": "ENTERPRISE_API"
    }
  ]
}

Error Responses

• 401 Unauthorized: Authentication failed or missing token.

• 403 Forbidden: Insufficient permissions to access organization members.

• 400 Bad Request: Missing or invalid query parameter(s).

Usage Notes

• The user_type parameter is required and must match a valid user type in your organization.

• The response includes an array of member objects with their id, name, email, and user_type.