---
title: "List of groups and all children belonging to the user logged session"
method: GET
path: "/group"
tags: ["group"]
---

# List of groups and all children belonging to the user logged session

`GET /group`

Retrieves detailed information for a specific organizational group by ID. Returns group configuration including hierarchy position, settings, permissions, and associated resources.

## Query parameters

- `id` integer, required

## Response `200`

Complete group information with hierarchy, settings, and configuration

- OrgUnitResponse
  - `group_id` integer — Organization unit (group) ID the call/record belongs to. Integer. Used to scope data; see /group/list for available group IDs.
  - `group_ext_id` string — A user defined external identifier for the group. Type: string.
  - `group_name` string, required — Human-readable name of the organization unit/group. String.
  - `group_parent_id` integer — The unique ID for the group that would be a parent to the current group. Type: integer (int32).
  - `top_group_id` integer — The unique ID for the top level group associated with current group. Type: integer (int32).
  - `billing_id` integer — The unique ID for the group that is the billing node. Type: integer (int32).
  - `address` string — Caller's street address. String.
  - `city` string — Caller's city (from caller-ID/location lookup). String.
  - `state` string — Caller's state (from caller-ID/location lookup). String (two-letter US state code).
  - `zip` string — The zip code for the group. Type: string.
  - `phone_number` string — Phone number as a string of digits. Typically 10 digits for US numbers.
  - `group_created` string, date — The date and time when the group was created. Type: string (date).
  - `group_modified` string, date-time — The date and time when the group was last updated. Type: string (date-time).
  - `industry_id` integer — The unique identifier for the industry selected. Type: integer (int32).
  - `industry_name` string — The name of the industry selected. Type: string.
  - `users` User[] — users. Type: array of object (User).
    - `ct_user_id` integer — Convirza user ID (platform user). Integer. Primary key of ct_user table.
    - `user_ext_id` string — An external identifier set for user. Type: string.
    - `first_name` string, required — The users first name. Type: string.
    - `last_name` string, required — The users last name. Type: string.
    - `user_title` string — The title given to the user. Type: string.
    - `user_status` 'active' | 'inactive' | 'suspended' — user_status. Type: enum (string); Allowed values: active, inactive, suspended.
    - `role_id` integer, required — The user account type set for user. Type: integer (int32).
    - `group_id` integer, required — Organization unit (group) ID the call/record belongs to. Integer. Used to scope data; see /group/list for available group IDs.
    - `user_email` string, required — The users e-mail address / login. Type: string.
    - `password` string, password — The password for the user account. Type: string (password).
    - `aliases` string — Comma separated list of user alias. Type: string.
    - `timezone` 'America/Halifax' | 'America/New_York' | 'America/Chicago' | 'America/Denver' | 'America/Phoenix' | 'America/Los_Angeles' | 'utc' — The users timezone. Type: enum (string); Allowed values: America/Halifax, America/New_York, America/Chicago, America/Denver, America/Phoenix, America/Los_Angeles, utc.

## Other responses

- `default` — Unexpected error

---

[API](https://skmtc.net/convirza/apis/convirza-apis.md) · [All operations](https://skmtc.net/convirza/apis/convirza-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/convirza/convirza-apis/versions/ccf9bbe34f5a/schema)