# getPages

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

***

## Function: getPages()

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

Defined in: [packages/sdk/src/main.ts:160](https://github.com/venuecms/sdk/blob/3bd84adbd3a78fae724fcf1d00721691a6434bb8/packages/sdk/src/main.ts#L160)

Get a list of all pages

### Parameters

| Parameter          | Type                                                                                                                                                                 |
| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `params`           | { `dir`: `"asc"` \| `"desc"`; `featured`: `boolean`; `limit`: `number`; `orderBy`: `string`; `page`: `number`; `query`: `string`; `tags`: `string` \| `string`\[]; } |
| `params.dir`?      | `"asc"` \| `"desc"`                                                                                                                                                  |
| `params.featured`? | `boolean`                                                                                                                                                            |
| `params.limit`?    | `number`                                                                                                                                                             |
| `params.orderBy`?  | `string`                                                                                                                                                             |
| `params.page`?     | `number`                                                                                                                                                             |
| `params.query`?    | `string`                                                                                                                                                             |
| `params.tags`?     | `string` \| `string`\[]                                                                                                                                              |

### Returns

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