# getProfile

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

***

## Function: getProfile()

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

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

Get a profile

### Parameters

| Parameter | Type                                                            |
| --------- | --------------------------------------------------------------- |
| `params`  | `Omit`<{ `siteKey`: `string`; `slug`: `string`; }, `"siteKey"`> |

### Returns

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