Users
Get all users
Returns every user in your account.
When to use. Fetch the full list of users, for example to sync accounts or build a directory. To fetch a single user you already know, use GET /users/{id} instead.
Parameters. Use the fields query parameter to select only the fields you need. Standard list filtering, ordering and limiting by any response field are supported.
Returns. { "users": [ { ... } ] }.
Example. GET /api/users
get/{sub_domain}/api/users
Request
- Base URLhttps://api.commpeak.com/dialer
- URLhttps://api.commpeak.com/dialer/{sub_domain}/api/users
- AuthAPI key in header Authorization
Path parameters
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.