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

***

# Function: getEntities()

> **getEntities**(`directory`): (`options`?) => `Promise`<`Entity`\[]>

Defined in: entities.ts:51

Returns all entities from EventCatalog.

You can optionally specify if you want to get the latest version of the entities.

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

| Parameter   | Type     |
| ----------- | -------- |
| `directory` | `string` |

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

`Function`

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

| Parameter             | Type                         |
| --------------------- | ---------------------------- |
| `options`?            | { `latestOnly`: `boolean`; } |
| `options.latestOnly`? | `boolean`                    |

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

`Promise`<`Entity`\[]>

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

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

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

// Gets all entities (and versions) from the catalog
const entities = await getEntities();

// Gets all entities (only latest version) from the catalog
const entities = await getEntities({ latestOnly: true });
```