---
title: "[BETA] get business profile"
method: POST
path: "/instances/{id}/client/action/get-business-profile"
tags: ["client"]
---

# [BETA] get business profile

`POST /instances/{id}/client/action/get-business-profile`

Retrieve a business profile. Defaults to the authenticated account. Only WhatsApp Business accounts expose a profile. Note: This endpoint is currently in beta and may change without notice.

## Path parameters

- `id` integer, required

## Request body

- object
  - `userId` string — Optional serialized contact ID. Omit to query the current account.
  - `withCompliance` boolean — Optional. Request compliance-augmented profile.

## Response `200`

Business profile retrieved successfully

- object
  - `instanceId` string — ID of the instance
  - `data` object
    - `profile` object — Business profile. Only populated for Business accounts.
      - `description` string, nullable
      - `email` string, nullable
      - `address` string, nullable
      - `website` object[]
        - `url` string
      - `categories` object[]
        - `id` string
        - `localized_display_name` string
      - `businessHours` object, nullable
      - `profileOptions` object, nullable
  - `status` 'success' | 'error'

## Other responses

- `401` — Unauthorized — invalid or missing bearer token
- `403` — Forbidden — insufficient permissions or account blocked
- `404` — Not found — instance does not exist or does not belong to you

---

[API](https://skmtc.net/waapi/apis/waapi-api.md) · [All operations](https://skmtc.net/waapi/apis/waapi-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/waapi/waapi-api/revisions/1e2cc7c12090/schema)