Skip to content

List and search users

List all users:

GET /api/v2/users.json

See also Paging through collections

Search users:

  • Search by user name, group name, tenant name, login, role or extension (partial match, case insensitive)

    GET /api/v2/users.json?search_term=john

  • Search by name (partial match, case insensitive)

    GET /api/v2/users.json?name=John%20Smith

  • Search by login (exact match)

    GET /api/v2/users.json?login=123456

  • Search by extension

    GET /api/v2/users.json?extension=123456

  • Search by group id

    GET /api/v2/users.json?group_id=d1d83c40-eec7-11e4-8558-e03f497dbdff

  • Search by tenant id

    GET /api/v2/users.json?tenant_id=2bfcefd4-f41d-11e4-983d-e03f497dbdff

  • Search by multiple parameters (tenant_id + search_term)

    GET /api/v2/users.json?tenant_id=2bfcefd4-f41d-11e4-983d-e03f497dbdff&search_term=supervisors