Get Business by ID
curl --request GET \
--url https://api.example.com/businesses/{businessID} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/businesses/{businessID}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/businesses/{businessID}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/businesses/{businessID}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/businesses/{businessID}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/businesses/{businessID}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/businesses/{businessID}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "Business details retrieved successfully.",
"data": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Acme Corporation",
"tin": "**-***6789",
"mobile": "+15550109999",
"official_website": "https://www.acme.com",
"public_website": "https://acme.com",
"social_account": "@acmecorp",
"address_line_1": "123 Main St",
"address_line_2": "Floor 4",
"address_city": "New York",
"address_state": "NY",
"address_postal_code": "10001",
"address_country": "US",
"created_at": "2024-01-01T08:00:00Z",
"created_by": "user_123",
"updated_at": "2024-03-12T10:30:00Z",
"updated_by": "user_456",
"status": "VERIFIED",
"industry": {
"id": "ind_99",
"name": "Hospitality",
"code": "HOSP",
"sector_code": "72",
"created_at": "2024-01-01T08:00:00Z",
"updated_at": "2024-03-12T10:30:00Z"
},
"mcc_id": "mcc_01",
"naics_id": "naics_01",
"is_deleted": false,
"naics_code": "722511",
"naics_title": "Full-Service Restaurants",
"mcc_code": "5812",
"mcc_title": "Eating Places and Restaurants",
"external_id": "EXT-98765",
"customer_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"is_monitoring_enabled": true,
"deleted_by": null,
"deleted_at": null,
"subscription": {
"status": "ACTIVE",
"created_at": "2024-01-01T08:00:00Z",
"updated_at": "2024-03-12T10:30:00Z"
},
"owners": [
{
"id": "owner_789",
"title": {
"id": "title_01",
"title": "Owner"
},
"first_name": "John",
"last_name": "Doe",
"ssn": "***-**-1234",
"email": "john.doe@example.com",
"mobile": "+15550101111",
"date_of_birth": "1980-01-01",
"apartment": "Apt 2B",
"line_1": "456 Owner Rd",
"line_2": null,
"city": "Brooklyn",
"state": "NY",
"postal_code": "11201",
"country": "US",
"created_at": "2024-01-01T08:00:00Z",
"created_by": "user_123",
"updated_at": "2024-03-12T10:30:00Z",
"updated_by": "user_456",
"ownership_percentage": 51,
"owner_type": "CONTROL"
}
],
"business_names": [
{
"name": "Acme Corp",
"is_primary": true
}
],
"business_addresses": [
{
"line_1": "123 Main St",
"apartment": "Suite 400",
"city": "New York",
"state": "NY",
"country": "US",
"postal_code": "10001",
"mobile": "+15550109999",
"is_primary": true
}
]
}
}{
"status": "fail",
"message": "Error message description.",
"errorCode": "<string>",
"data": {}
}{
"status": "fail",
"message": "Error message description.",
"errorCode": "<string>",
"data": {}
}{
"status": "fail",
"message": "Error message description.",
"errorCode": "<string>",
"data": {}
}Business
Get Business By ID
Retrieve details for a particular business associated with the businessID provided
GET
/
businesses
/
{businessID}
Get Business by ID
curl --request GET \
--url https://api.example.com/businesses/{businessID} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/businesses/{businessID}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/businesses/{businessID}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/businesses/{businessID}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/businesses/{businessID}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/businesses/{businessID}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/businesses/{businessID}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "Business details retrieved successfully.",
"data": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Acme Corporation",
"tin": "**-***6789",
"mobile": "+15550109999",
"official_website": "https://www.acme.com",
"public_website": "https://acme.com",
"social_account": "@acmecorp",
"address_line_1": "123 Main St",
"address_line_2": "Floor 4",
"address_city": "New York",
"address_state": "NY",
"address_postal_code": "10001",
"address_country": "US",
"created_at": "2024-01-01T08:00:00Z",
"created_by": "user_123",
"updated_at": "2024-03-12T10:30:00Z",
"updated_by": "user_456",
"status": "VERIFIED",
"industry": {
"id": "ind_99",
"name": "Hospitality",
"code": "HOSP",
"sector_code": "72",
"created_at": "2024-01-01T08:00:00Z",
"updated_at": "2024-03-12T10:30:00Z"
},
"mcc_id": "mcc_01",
"naics_id": "naics_01",
"is_deleted": false,
"naics_code": "722511",
"naics_title": "Full-Service Restaurants",
"mcc_code": "5812",
"mcc_title": "Eating Places and Restaurants",
"external_id": "EXT-98765",
"customer_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"is_monitoring_enabled": true,
"deleted_by": null,
"deleted_at": null,
"subscription": {
"status": "ACTIVE",
"created_at": "2024-01-01T08:00:00Z",
"updated_at": "2024-03-12T10:30:00Z"
},
"owners": [
{
"id": "owner_789",
"title": {
"id": "title_01",
"title": "Owner"
},
"first_name": "John",
"last_name": "Doe",
"ssn": "***-**-1234",
"email": "john.doe@example.com",
"mobile": "+15550101111",
"date_of_birth": "1980-01-01",
"apartment": "Apt 2B",
"line_1": "456 Owner Rd",
"line_2": null,
"city": "Brooklyn",
"state": "NY",
"postal_code": "11201",
"country": "US",
"created_at": "2024-01-01T08:00:00Z",
"created_by": "user_123",
"updated_at": "2024-03-12T10:30:00Z",
"updated_by": "user_456",
"ownership_percentage": 51,
"owner_type": "CONTROL"
}
],
"business_names": [
{
"name": "Acme Corp",
"is_primary": true
}
],
"business_addresses": [
{
"line_1": "123 Main St",
"apartment": "Suite 400",
"city": "New York",
"state": "NY",
"country": "US",
"postal_code": "10001",
"mobile": "+15550109999",
"is_primary": true
}
]
}
}{
"status": "fail",
"message": "Error message description.",
"errorCode": "<string>",
"data": {}
}{
"status": "fail",
"message": "Error message description.",
"errorCode": "<string>",
"data": {}
}{
"status": "fail",
"message": "Error message description.",
"errorCode": "<string>",
"data": {}
}Authorizations
Path Parameters
Query Parameters
Response
Business details retrieved successfully.
Standard response wrapping the business details data.
Was this page helpful?