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

9da73dd2f99e

users

Get a user by ID

Retrieves detailed information about a specific user, including their profile, assigned phone numbers, status (active, archived), and configuration. Use this to inspect a user's setup before making changes or to verify user existence.

Permission: Users Read required.

Monitoring impact:

  • OFF: Returns data only if userId matches your own user ID. Requesting another user's ID returns 404.
  • ON: Returns data for any user in the team.
get/users/{userId}

Path parameters

userIdinteger required

The identifier of the user

Response

Successful operation

user_idinteger

The user identifier

team_idinteger

The team identifier of the user

initialstring

The initials of the user

colorstring
firstnamestring

The firstname of the user

lastnamestring

The lastname of the user

companystring

The company of the user

emailstring

The email of the user

picturestring

The picture of the user

concat_namestring
plantypestring

The category of the plan, mirrors plan.type

Example response

{
  "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"
}