Organization Users

The Organization Users API allows you to manage users within your organization, including listing users, viewing user details, and removing users.

User Properties

Property	Type	Description
`id`	integer	Unique identifier for the user
`email`	string	User’s email address
`display_name`	string	User’s display name
`is_admin`	boolean	Whether the user has admin privileges
`waiting_room_url`	string	URL to the user’s waiting room
`created_at`	string	ISO 8601 timestamp of when the user was created
`updated_at`	string	ISO 8601 timestamp of when the user was last updated

Endpoints

List Organization Users

Retrieve a paginated list of all users in your organization.


GET /api/external/organization_users

Parameters

Parameter	Type	Location	Required	Description
`email`	string	query	No	Filter by email address
`page`	integer	query	No	Page number for pagination
`per_page`	integer	query	No	Number of results per page

Example Request


curl -X GET "https://api.kismethealth.com/api/external/organization_users?page=1&per_page=25" \
  -H "X-Client-ID: your-client-id" \
  -H "X-Client-Secret: your-client-secret" \
  -H "Content-Type: application/json"

Example Response


{
  "organization_users": [
    {
      "id": 1,
      "email": "user@example.com",
      "is_admin": true,
      "display_name": "Jane Doe",
      "waiting_room_url": "https://app.kismethealth.com/meet/janes-room",
      "created_at": "2025-07-16T14:00:00Z",
      "updated_at": "2025-07-16T14:05:00Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 25,
    "total_pages": 4,
    "total_count": 100
  }
}

Get User Details

Retrieve detailed information about a specific organization user, including their waiting room details.


GET /api/external/organization_users/{id}

Parameters

Parameter	Type	Location	Required	Description
`id`	integer	path	Yes	ID of the organization user

Example Request


curl -X GET "https://api.kismethealth.com/api/external/organization_users/1" \
  -H "X-Client-ID: your-client-id" \
  -H "X-Client-Secret: your-client-secret" \
  -H "Content-Type: application/json"

Example Response


{
  "id": 1,
  "email": "user@example.com",
  "is_admin": true,
  "display_name": "Jane Doe",
  "waiting_room_url": "https://app.kismethealth.com/meet/janes-room",
  "created_at": "2025-07-16T14:00:00Z",
  "updated_at": "2025-07-16T14:05:00Z",
  "waiting_room": {
    "id": 501,
    "user_id": 101,
    "slug": "janes-room",
    "theme": "safari",
    "is_active": true,
    "created_at": "2025-07-16T14:00:00Z",
    "updated_at": "2025-07-16T14:05:00Z",
    "user": {
      "display_name": "Jane Doe"
    }
  }
}

Delete Organization User

Remove a user from your organization.


DELETE /api/external/organization_users/{id}

Parameters

Parameter	Type	Location	Required	Description
`id`	integer	path	Yes	ID of the organization user

Example Request


curl -X DELETE "https://api.kismethealth.com/api/external/organization_users/1" \
  -H "X-Client-ID: your-client-id" \
  -H "X-Client-Secret: your-client-secret" \
  -H "Content-Type: application/json"

Example Response


Status: 204 No Content