---
title: "Get team information"
method: GET
path: "/teams"
tags: ["teams"]
---

# Get team information

`GET /teams`

Retrieves a complete `team` object containing lists of `numbers`, `users`, `ivrs`, `conferences`, `tags` and `groups`.

**Permission:** No specific permission required.

**Monitoring impact:**
- *OFF*: Returns limited team data.
- *ON*: Returns the full team object with all nested resources.

## Response `200`

Successful operation

- Team
  - `team_id` integer — Unique identifier for the object
  - `name` string — The name of your team
  - `total_numbers_count` integer — The size of numbers array
  - `numbers` Number[]
    - `number` integer — Phone number in E.164 format without the `+` prefix (e.g., `33612345678`).
    - `label` string — The label of the number
    - `type` string — The type of the number
    - `user_id` integer — The user identifier
    - `ivr_id` integer — The unique identifier of the IVR. Use `GET /ivrs` to discover available IVR IDs.
    - `conference_id` integer — The conference identifier
    - `is_sms` boolean
    - `is_sms_write` boolean
    - `is_callable` boolean
    - `format` FormatNumber
      - `raw` integer
      - `country_code` string
      - `country` string
      - `e164` string
      - `international` string
      - `international_alt` string
      - `national` string
      - `national_alt` string
      - `rfc3966` string
      - `is_short_code` boolean
  - `total_users_count` integer — The size of users array
  - `users` UserFull[]
    - `user_id` integer — The user identifier
    - `team_id` integer — The team identifier of the user
    - `initial` string — The initials of the user
    - `color` string
    - `firstname` string — The firstname of the user
    - `lastname` string — The lastname of the user
    - `company` string — The company of the user
    - `email` string — The email of the user
    - `picture` string — The picture of the user
    - `concat_name` string
    - `numbers` Number[] — The numbers of the user
      - `number` integer — Phone number in E.164 format without the `+` prefix (e.g., `33612345678`).
      - `label` string — The label of the number
      - `type` string — The type of the number
      - `user_id` integer — The user identifier
      - `ivr_id` integer — The unique identifier of the IVR. Use `GET /ivrs` to discover available IVR IDs.
      - `conference_id` integer — The conference identifier
      - `is_sms` boolean
      - `is_sms_write` boolean
      - `is_callable` boolean
      - `format` FormatNumber
        - `raw` integer
        - `country_code` string
        - `country` string
        - `e164` string
        - `international` string
        - `international_alt` string
        - `national` string
        - `national_alt` string
        - `rfc3966` string
        - `is_short_code` boolean
    - `plan` object — The licence plan assigned to the user
      - `id` integer — The plan identifier
      - `name` string — The commercial name of the plan
      - `type` string — The category of the plan
    - `plantype` string — The category of the plan, mirrors `plan.type`
  - `total_ivrs_count` integer — The size of ivrs array
  - `ivrs` Ivr[]
    - `ivr_id` integer — The identifier of the ivr
    - `name` string — The name of the ivr
    - `color` 'ff6b6b' | 'F06292' | 'BA68C8' | '9575CD' | '7986CB' | '64B5F6' | '4FC3F7' | '4DD0E1' | '4DB6AC' | '81C784' | 'AED581' | 'DCE775' | 'FFD54F' | 'FFB74D' | 'FF8A65' | 'A1887F' | 'E0E0E0' | '90A4AE'
    - `numbers` Number[] — The numbers of the ivr
      - `number` integer — Phone number in E.164 format without the `+` prefix (e.g., `33612345678`).
      - `label` string — The label of the number
      - `type` string — The type of the number
      - `user_id` integer — The user identifier
      - `ivr_id` integer — The unique identifier of the IVR. Use `GET /ivrs` to discover available IVR IDs.
      - `conference_id` integer — The conference identifier
      - `is_sms` boolean
      - `is_sms_write` boolean
      - `is_callable` boolean
      - `format` FormatNumber
        - `raw` integer
        - `country_code` string
        - `country` string
        - `e164` string
        - `international` string
        - `international_alt` string
        - `national` string
        - `national_alt` string
        - `rfc3966` string
        - `is_short_code` boolean
    - `scenarios` Scenario[]
      - `scenario_id` integer — The scenario identifier
      - `ivr_id` integer — The unique identifier of the IVR. Use `GET /ivrs` to discover available IVR IDs.
      - `name` string — The name of the scenario
      - `color` string
      - `scenario_type` 'menu' | 'announce' | 'queue' | 'sms' | 'webhook' | 'input' — The type of the scenario
      - `is_default` boolean
    - `is_open` boolean — The ivr is open or not
  - `total_conferences_count` integer — The size of conferences array
  - `conferences` Conference[]
    - `conference_id` integer — The conference identifier
    - `name` string — The name of the conference
    - `numbers` Number[] — The numbers of the conference
      - `number` integer — Phone number in E.164 format without the `+` prefix (e.g., `33612345678`).
      - `label` string — The label of the number
      - `type` string — The type of the number
      - `user_id` integer — The user identifier
      - `ivr_id` integer — The unique identifier of the IVR. Use `GET /ivrs` to discover available IVR IDs.
      - `conference_id` integer — The conference identifier
      - `is_sms` boolean
      - `is_sms_write` boolean
      - `is_callable` boolean
      - `format` FormatNumber
        - `raw` integer
        - `country_code` string
        - `country` string
        - `e164` string
        - `international` string
        - `international_alt` string
        - `national` string
        - `national_alt` string
        - `rfc3966` string
        - `is_short_code` boolean
  - `total_tags_count` integer — The size of tags array
  - `tags` Tag[]
    - `tag_id` integer — The identifier of the tag
    - `name` string — The name of the tag
    - `color` 'ff6b6b' | 'F06292' | 'BA68C8' | '9575CD' | '7986CB' | '64B5F6' | '4FC3F7' | '4DD0E1' | '4DB6AC' | '81C784' | 'AED581' | 'DCE775' | 'FFD54F' | 'FFB74D' | 'FF8A65' | 'A1887F' | 'E0E0E0' | '90A4AE'
    - `description` string — The description of the tag
    - `creation_date` string, date-time
  - `total_groups_count` integer — The size of groups array
  - `groups` GroupLight[]
    - `group_id` integer — The identifier of the group
    - `name` string — The name of the group
    - `total_users_count` integer — The number of users in the group
    - `color` string
    - `is_jumper` boolean — Allow users to jump into

## Other responses

- `401` — Authentication token is missing, invalid, or expired
- `500` — Internal server error

---

[API](https://skmtc.net/ringover/apis/ringover-public-api.md) · [All operations](https://skmtc.net/ringover/apis/ringover-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ringover/ringover-public-api/revisions/9da73dd2f99e/schema)