# getProfiles

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

***

## Function: getProfiles()

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

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

Get a list of profiles

### Parameters

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

### Returns

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