Copy as Markdown[View as Markdown](/docs/sdk/functions/getUsers.md)

***

# Function: getUsers()

> **getUsers**(`catalogDir`): (`options`?) => `Promise`<`User`\[]>

Defined in: users.ts:56

Returns all users from EventCatalog.

## Parameters[​](#parameters "Direct link to Parameters")

| Parameter    | Type     |
| ------------ | -------- |
| `catalogDir` | `string` |

## Returns[​](#returns "Direct link to Returns")

`Function`

### Parameters[​](#parameters-1 "Direct link to Parameters")

| Parameter  | Type |
| ---------- | ---- |
| `options`? | {}   |

### Returns[​](#returns-1 "Direct link to Returns")

`Promise`<`User`\[]>

## Example[​](#example "Direct link to Example")

```
import utils from '@eventcatalog/utils';

const { getUsers } = utils('/path/to/eventcatalog');

// Gets all users from the catalog
const channels = await getUsers();
```