# getEvents

[**@venuecms/sdk-next**](https://docs.venuecms.com/developers/sdk-next/reference/index)

***

## Function: getEvents()

```ts
function getEvents(params): Promise<
  | {
  data: undefined;
  error: unknown;
 }
  | {
  data: GetEventsResponse;
  error: undefined;
} & object>
```

Defined in: [sdk-next/src/lib/api/index.ts:37](https://github.com/venuecms/sdk/blob/fccd7a6c5d53db66655878a682d412275fbffc69/packages/sdk-next/src/lib/api/index.ts#L37)

Get a list of events (cached)

### Parameters

| Parameter | Type                                                                                                                                                                                                                                                                                                         |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `params`  | \| `undefined` \| { `dir`: `"asc"` \| `"desc"`; `featured`: `null` \| `boolean`; `gt`: `null` \| `number`; `legacyId`: `string`; `limit`: `null` \| `number`; `lt`: `null` \| `number`; `orderBy`: `string`; `page`: `null` \| `number`; `tags`: `string` \| `string`\[]; `upcoming`: `null` \| `boolean`; } |

### Returns

`Promise`< | { `data`: `undefined`; `error`: `unknown`; } | { `data`: [`GetEventsResponse`](https://docs.venuecms.com/developers/sdk-next/reference/type-aliases/geteventsresponse); `error`: `undefined`; } & `object`>