List Users

Retrieve a paginated list of users and their device details in your account. Equivalent to Bulk Get User & Device Details in the legacy portal.

GET/v2/accounts/{account_sid}/users

HTTP Request

GET /v2/accounts/<account_sid>/users

Regional Base URLs

Region	Base URL
Singapore	https://ccm-api.exotel.com
Mumbai	https://ccm-api.in.exotel.com

Example

cURL

curl -u '<api_key>:<api_token>' -X GET \
  'https://ccm-api.in.exotel.com/v2/accounts/<account_sid>/users?fields=devices&limit=50' \
  -H 'Content-Type: application/json'

Python

import requests

response = requests.get(
    'https://ccm-api.in.exotel.com/v2/accounts/<account_sid>/users',
    auth=('<api_key>', '<api_token>'),
    headers={'Content-Type': 'application/json'},
    params={'fields': 'devices', 'limit': 50}
)

print(response.json())

Node.js

const apiKey = '<api_key>';
const apiToken = '<api_token>';
const accountSid = '<account_sid>';

const url = `https://ccm-api.in.exotel.com/v2/accounts/${accountSid}/users?fields=devices&limit=50`;

const response = await fetch(url, {
  headers: {
    'Authorization': 'Basic ' + Buffer.from(`${apiKey}:${apiToken}`).toString('base64'),
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);

PHP

<?php
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_USERPWD => "<api_key>:<api_token>",
  CURLOPT_URL => "https://ccm-api.in.exotel.com/v2/accounts/<account_sid>/users?fields=devices&limit=50",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => array("Content-Type: application/json"),
));

$response = curl_exec($curl);
curl_close($curl);

echo $response;
?>

Go

package main

import (
    "fmt"
    "io/ioutil"
    "net/http"
)

func main() {
    url := "https://ccm-api.in.exotel.com/v2/accounts/<account_sid>/users?fields=devices&limit=50"

    req, _ := http.NewRequest("GET", url, nil)
    req.SetBasicAuth("<api_key>", "<api_token>")
    req.Header.Add("Content-Type", "application/json")

    res, _ := http.DefaultClient.Do(req)
    defer res.Body.Close()

    body, _ := ioutil.ReadAll(res.Body)
    fmt.Println(string(body))
}

info

This API supports JSON response only. Pass fields=devices to include device status in the response.

Query Parameters

Parameter	Description
fields	Comma-separated additional fields: devices, active_call, last_login
devices.contact_uri	Filter by phone number (E.164 format, URL encoded)
email	Filter by email address
offset	Pagination start position (default: 0)
limit	Records per page (default: 20, max: 50)

Response

{
  "request_id": "string",
  "method": "GET",
  "http_code": 200,
  "metadata": {
    "total": 45,
    "count": 20,
    "offset": 0,
    "limit": 20
  },
  "response": [
    {
      "code": 200,
      "status": "success",
      "data": {
        "id": "user_uuid",
        "first_name": "John",
        "last_name": "Doe",
        "email": "john@example.com",
        "email_verified": true,
        "role": "user",
        "active_call": null,
        "last_login": "2024-01-15T10:30:00Z",
        "date_created": "2024-01-01T00:00:00Z",
        "date_updated": "2024-01-15T10:30:00Z",
        "devices": [
          {
            "id": 1,
            "name": "Agent Phone",
            "contact_uri": "+919999999999",
            "type": "tel",
            "available": true,
            "verified": true,
            "status": "free"
          }
        ]
      }
    }
  ]
}

---

Get Single User

GET /v2/accounts/<account_sid>/users/<user_id>

Returns the same structure as the list response, but for a single user object.

Try It