Recover a Business.

GET 
/api/v2/business/:businessId

Bring the information of a business with its respective instances and connected numbers.

Request

Path Parameters

businessId stringrequired

Business ID.

Responses

200

BusinessFindResponse

application/json

Schema

Schema

businessId stringrequired
name stringrequired
businessToken stringrequired
attributes objectrequired
createdAt date-timerequired
updatedAt date-timerequired
deletedAt date-timerequired
BusinessWebhook object
webhookId stringrequired
url stringrequired
enabled booleanrequired
createdAt date-timerequired
updatedAt date-timerequired

Example (from schema)

{
  "businessId": "string",
  "name": "string",
  "businessToken": "string",
  "attributes": {},
  "createdAt": "2025-06-12T13:21:07.041Z",
  "updatedAt": "2025-06-12T13:21:07.041Z",
  "deletedAt": "2025-06-12T13:21:07.041Z",
  "BusinessWebhook": {
    "webhookId": "string",
    "url": "string",
    "enabled": true,
    "createdAt": "2025-06-12T13:21:07.042Z",
    "updatedAt": "2025-06-12T13:21:07.042Z"
  }
}

400

BadRequestException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

401

UnauthorizedException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

500

InternalServerErrorException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

Loading...