---
title: "Get Directory"
method: GET
path: "/users/directory"
tags: ["Users", "users"]
---

# Get Directory

`GET /users/directory`

## Request

- Base URL: `https://api.fonestorm.com/v2`
- URL: `https://api.fonestorm.com/v2/users/directory`
- Auth: API key in header `token`

The account's users that have a fonenumber, sorted by name, each with the device assigned to them (via fractelfone). Users come from the same source as GET /users, so an account that may not list users gets a 403. A user with no device, or whose device has no caller id, is left out.

## Query parameters

- `tenant` 'fractel' | 'fonestorm'

## Response `200`

Success

- object
  - `directory` DirectoryEntry[]
    - `name` string: Display name - the user's first and last name, else the email.
    - `first_name` string: User first name.
    - `last_name` string: User last name.
    - `email` string: User email.
    - `title` string: User title.
    - `speed_dial` string: The device's directory speed dial if set, else its extension.
    - `fonenumber` string: Device caller id. Always present; users without one are not listed.
    - `device_id` string: Device id.
    - `device_type` string: Device type.
    - `show` string: The device's directory setting - 'No', 'Name Only' or 'Name and Extension'.

## Other responses

- `401`: Unauthorized
- `403`: Not permitted to list users for this account
- `default`: Error

---

[API](https://skmtc.dev/fonestorm/apis/fractel-api-2-12-87c-hail.md) · [All operations](https://skmtc.dev/fonestorm/apis/fractel-api-2-12-87c-hail/llms.txt) · [OpenAPI document](https://skmtc.dev/fonestorm/apis/fractel-api-2-12-87c-hail/revisions/9738d9b806d4?raw)