Users

Get user

Returns the full record for a single user.

When to use. Fetch one user when you already know their ID. To list all users, use GET /users instead.

Parameters. id (path, required): the ID of the user to fetch.

Returns. { "users": [ { ... } ] } containing the requested user.

Example. GET /api/users/5

get/{sub_domain}/api/users/{id}

Request

  • Base URL
    https://api.commpeak.com/dialer
  • URL
    https://api.commpeak.com/dialer/{sub_domain}/api/users/{id}
  • Auth
    API key in header Authorization

Path parameters

idinteger required

User ID.

sub_domainstring required

Dialer Name (subdomain)

Response

Successful Response

Example response

{
  "users": [
    {
      "email": "test@example.com",
      "first_name": "John",
      "id": 2,
      "last_name": "Doe",
      "username": "demo",
      "virtual_extension": 1001
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.