---
title: "Consultar perfil comercial"
method: GET
path: "/v1/organizations/me/business-profile"
tags: ["Números"]
---

# Consultar perfil comercial

`GET /v1/organizations/me/business-profile`

## Request

- Base URL: `https://api.ararahq.com`
- URL: `https://api.ararahq.com/v1/organizations/me/business-profile`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/ararahq/apis/ararahq-api/docs/v1/organizations/me/business-profile/get.ts> (a function with typed inputs; its response is checked against the schema)

Perfil comercial salvo na Arara e o estado da publicação no WhatsApp. Permissão: `ADMIN`.

## Response `200`

Perfil

- BusinessProfileResponse
  - `id` string, uuid, nullable
  - `displayName` string, nullable
  - `vertical` string, nullable
  - `description` string, nullable
  - `aboutShort` string, nullable
  - `email` string, nullable
  - `websites` string[], nullable
  - `businessHours` object, nullable
  - `profilePhotoUrl` string, nullable
  - `awayMessage` string, nullable
  - `metaSyncStatus` string, required
  - `metaSyncedAt` string, date-time, nullable
  - `metaSyncError` string, nullable
  - `updatedAt` string, date-time, nullable

## Other responses

- `401`: Chave inexistente, revogada, expirada, com prefixo errado (`ara_` sem `ara_live_`) ou vinda de IP fora da allowlist. O corpo é o JSON padrão do Spring, sem `error.code`.
- `403`: Dois casos, com corpos diferentes: - Autenticação: header `Authorization` ausente, Bearer que não começa com `ara_`, chave sem a permissão da rota ou rota que não aceita chave de API. Corpo no formato padrão do Spring, sem `error.code`. - Regra de negócio, no formato `{ "error": { ... } }`: `PLAN_FEATURE_LOCKED`, `PLAN_LIMIT_REACHED`, `ACCOUNT_NOT_ACTIVATED`, `NO_DEDICATED_NUMBER`, `ORGANIZATION_SUSPENDED`, `NUMBER_BLOCKED`, `FRAUD_SUSPECTED`, `RESOURCE_FORBIDDEN`, `VIEWER_READ_ONLY`.
- `429`: `RATE_LIMIT_EXCEEDED`: limite geral da API (1.200 leituras ou 3.000 escritas por minuto, por usuário da chave).

## Changes

- **2026-10-12** `d576cd28afc0`: 3 info
  - api tag `Números` added
  - api tag `business-profile` removed
  - added the non-success response with the status `429`
- **2026-09-15** `372d8c2e735d`: 4 breaking, 1 warning, 9 info
  - the response property `error` became optional for the status `401`
  - the `error` response's property type changed from `object` to `string` for status `401`
  - removed the required property `error/code` from the response with the `401` status
  - removed the required property `error/message` from the response with the `401` status
  - …10 more
- **2026-05-25** `4e426b85f784`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/ararahq/apis/ararahq-api/changes/v1/organizations/me/business-profile/get.md)

---

[API](https://skmtc.dev/ararahq/apis/ararahq-api.md) - [All operations](https://skmtc.dev/ararahq/apis/ararahq-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ararahq/apis/ararahq-api/revisions/d576cd28afc0?raw)