latestOpenAPI 3.1.1Proprietary – Contact us for usage terms2026-08-20173183551.4 KB

9da73dd2f99e

teams

Get team information

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.
get/teams

Response

Successful operation

team_idinteger

Unique identifier for the object

namestring

The name of your team

total_numbers_countinteger

The size of numbers array

total_users_countinteger

The size of users array

total_ivrs_countinteger

The size of ivrs array

total_conferences_countinteger

The size of conferences array

total_tags_countinteger

The size of tags array

total_groups_countinteger

The size of groups array

Example response

{
  "team_id": 123456,
  "name": "My Company",
  "total_numbers_count": 1,
  "numbers": [
    {
      "number": 33184800000,
      "label": "myfavoritenumber",
      "type": "PHONE",
      "user_id": 60907,
      "ivr_id": 60908,
      "conference_id": 60908,
      "format": {
        "raw": 184800000,
        "country_code": "33",
        "country": "FR",
        "e164": "+33184800000",
        "international": "+33 1 84 80 00 00",
        "international_alt": "33184800000",
        "national": "01 84 80 00 00",
        "national_alt": "0184800000",
        "rfc3966": "tel:+33-1-84-80-00-00"
      }
    }
  ],
  "total_users_count": 1,
  "users": [
    {
      "user_id": 123456,
      "team_id": 123456,
      "initial": "PM",
      "color": "3CC8C8",
      "firstname": "Pauline",
      "lastname": "Martin",
      "company": "Ringover",
      "email": "pauline.martin@ringover.com",
      "picture": "https://cdn77.ringover.com/img/users/default.jpg",
      "concat_name": "Pauline Martin",
      "numbers": [
        {
          "number": 33184800000,
          "label": "myfavoritenumber",
          "type": "PHONE",
          "user_id": 60907,
          "ivr_id": 60908,
          "conference_id": 60908,
          "format": {
            "raw": 184800000,
            "country_code": "33",
            "country": "FR",
            "e164": "+33184800000",
            "international": "+33 1 84 80 00 00",
            "international_alt": "33184800000",
            "national": "01 84 80 00 00",
            "national_alt": "0184800000",
            "rfc3966": "tel:+33-1-84-80-00-00"
          }
        }
      ],
      "plan": {
        "id": 3,
        "name": "BUSINESS",
        "type": "voice"
      },
      "plantype": "voice"
    }
  ],
  "total_ivrs_count": 1,
  "ivrs": [
    {
      "ivr_id": 123456,
      "name": "StandardFacile",
      "color": "ff6b6b",
      "numbers": [
        {
          "number": 33184800000,
          "label": "myfavoritenumber",
          "type": "PHONE",
          "user_id": 60907,
          "ivr_id": 60908,
          "conference_id": 60908,
          "format": {
            "raw": 184800000,
            "country_code": "33",
            "country": "FR",
            "e164": "+33184800000",
            "international": "+33 1 84 80 00 00",
            "international_alt": "33184800000",
            "national": "01 84 80 00 00",
            "national_alt": "0184800000",
            "rfc3966": "tel:+33-1-84-80-00-00"
          }
        }
      ],
      "scenarios": [
        {
          "scenario_id": 123456,
          "ivr_id": 1234,
          "name": "myscenario",
          "color": "123456",
          "scenario_type": "menu",
          "is_default": true
        }
      ],
      "is_open": true
    }
  ],
  "total_conferences_count": 1,
  "conferences": [
    {
      "conference_id": 60908,
      "name": "SoConference",
      "numbers": [
        {
          "number": 33184800000,
          "label": "myfavoritenumber",
          "type": "PHONE",
          "user_id": 60907,
          "ivr_id": 60908,
          "conference_id": 60908,
          "format": {
            "raw": 184800000,
            "country_code": "33",
            "country": "FR",
            "e164": "+33184800000",
            "international": "+33 1 84 80 00 00",
            "international_alt": "33184800000",
            "national": "01 84 80 00 00",
            "national_alt": "0184800000",
            "rfc3966": "tel:+33-1-84-80-00-00"
          }
        }
      ]
    }
  ],
  "total_tags_count": 1,
  "tags": [
    {
      "tag_id": 123,
      "name": "mytag",
      "color": "ff6b6b",
      "description": "my tag description",
      "creation_date": "2018-08-12T12:12:40.53Z"
    }
  ],
  "total_groups_count": 1,
  "groups": [
    {
      "group_id": 999999,
      "name": "myIVR",
      "color": "FFD54F"
    }
  ]
}