users

List all team users

Changed on

Retrieves users from your team. Each user object includes the user's profile information, assigned phone numbers, status, and configuration. The total number of users is indicated in the list_count field.

Permission: Users Read required.

Monitoring impact:

  • OFF: Returns only your own user data as a single-item list. You cannot see other team members.
  • ON: Returns all users in the team with their full details.
get/users

Request

  • Base URL
    https://public-api.ringover.com/v2
  • URL
    https://public-api.ringover.com/v2/users
  • Auth
    API key in header Authorization

Response

Successful operation

list_countinteger

The size of the list

Example response

{
  "list_count": 1,
  "list": [
    {
      "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"
    }
  ]
}

Changes

  • dac34ebedef3Revision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

  • d92d55716cc3Revision changes
    • info

      api operation id getUsers was added

    • info

      removed the non-success response with the status