GET /business/{business_id} — Retrieve Business Profile

Use this endpoint to retrieve details of your Convo business account, including the owner’s contact information, billing currency, timezone, and the list of project IDs that belong to the business.

Endpoint

GET https://connect.api-wa.co/project-apis/v1/business/{business_id}

Path Parameters

string

required

The unique ID of your business. You can find this in your Convo dashboard under Settings → Business Profile.

Request Example

curl https://connect.api-wa.co/project-apis/v1/business/61f0624bcf0a58553378ceb4 \
  -H "X-API-WA-Project-API-Pwd: YOUR_API_PASSWORD"

Response (200 OK)

string

The unique identifier of the business. Identical to business_id.

boolean

Indicates whether the business owner has logged in recently. true means the account is active.

string

The display name of the business owner as shown in the Convo dashboard.

array of strings

A list of project IDs associated with this business account. Each project corresponds to a WhatsApp Business number.

string

The login username (typically an email address) of the business owner.

string

The unique business identifier. Same value as id.

string

The email address of the business owner on record with Convo.

integer

Unix timestamp in milliseconds representing when the business account was created.

integer

Unix timestamp in milliseconds representing the last time the business record was updated.

string

The registered company or business name.

string

The primary phone number of the business owner, including country code (e.g. 918116856154).

string

The billing currency for this business account. Either INR or USD.

string

The timezone configured for this business (e.g. Asia/Calcutta). Affects campaign scheduling and reporting.

string

The role of the authenticated user relative to this business. One of owner, manager, or agent.

Response Example

{
  "id": "61f0624bcf0a58553378ceb4",
  "active": true,
  "display_name": "Shop XY",
  "project_ids": ["61f06252cf0a58553378ceb5"],
  "user_name": "owner@example.com",
  "business_id": "61f0624bcf0a58553378ceb4",
  "email": "owner@example.com",
  "created_at": 1643143755321,
  "updated_at": 1643143755321,
  "company": "Shop XY",
  "contact": "918116856154",
  "currency": "INR",
  "timezone": "Asia/Calcutta",
  "type": "owner"
}

Error Responses

object

Returned when the business_id format is invalid or cannot be parsed.

{
  "name": "ERR400",
  "message": "Invalid Business ID!"
}

object

Returned when no business account matching the provided business_id exists.

{
  "name": "ERR404",
  "message": "Business doesn't exist!"
}

object

Returned when an unexpected error occurs on Convo’s servers. Retry the request with exponential back-off.

{
  "name": "ERR500",
  "message": "Internal server error."
}

Overview

Business & Project

Messages

Contacts

Templates

Campaigns

Webhooks

Catalogue

Media

GET /business/{business_id} — Retrieve Business Profile

Endpoint

Path Parameters

Request Example

Response (200 OK)

Response Example

Error Responses

​Endpoint

​Path Parameters

​Request Example

​Response (200 OK)

​Response Example

​Error Responses

Endpoint

Path Parameters

Request Example

Response (200 OK)

Response Example

Error Responses