cURL
curl --request GET \
--url https://api.gmbapi.com/external-api/gmb/oauth/apple/companies/{apple_company_id}/brands \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.gmbapi.com/external-api/gmb/oauth/apple/companies/{apple_company_id}/brands"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.gmbapi.com/external-api/gmb/oauth/apple/companies/{apple_company_id}/brands', 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.gmbapi.com/external-api/gmb/oauth/apple/companies/{apple_company_id}/brands",
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.gmbapi.com/external-api/gmb/oauth/apple/companies/{apple_company_id}/brands"
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.gmbapi.com/external-api/gmb/oauth/apple/companies/{apple_company_id}/brands")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gmbapi.com/external-api/gmb/oauth/apple/companies/{apple_company_id}/brands")
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{
"success": true,
"payload": {
"apple_company_id": "COMPANY123",
"brands": [
{
"apple_brand_id": "BRAND123",
"name": "Example Brand",
"brand_name": "Example Brand",
"country_code": "US",
"categories": [
"dining.restaurant",
"dining.cafe"
],
"website_url": "https://example.com",
"app_store_url": null,
"ownership_type": "BRAND_OWNER",
"connected": true,
"segment_id": "brand-550e8400-e29b-41d4-a716-446655440000",
"account_id": "123"
},
{
"apple_brand_id": "BRAND456",
"name": "Unlinked Brand",
"brand_name": "Unlinked Brand",
"country_code": "DE",
"categories": [
"dining.cafe"
],
"website_url": null,
"app_store_url": null,
"ownership_type": null,
"connected": false,
"segment_id": null,
"account_id": null
}
]
}
}{
"error": 123,
"message": "<string>"
}{
"error": 123,
"message": "<string>"
}{
"error": 123,
"message": "<string>"
}{
"error": 123,
"message": "<string>"
}Apple Brands
List Apple Company Brands
Returns the brands Apple Business Connect currently has for a connected company. Read live from Apple, so brands created after the OAuth grant appear without re-authorizing. Each brand is flagged when a GMBapi brand segment already exists (connected, plus segment_id and account_id). categories are Apple taxonomy ids, not Google gcids.
GET
/
oauth
/
apple
/
companies
/
{apple_company_id}
/
brands
cURL
curl --request GET \
--url https://api.gmbapi.com/external-api/gmb/oauth/apple/companies/{apple_company_id}/brands \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.gmbapi.com/external-api/gmb/oauth/apple/companies/{apple_company_id}/brands"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.gmbapi.com/external-api/gmb/oauth/apple/companies/{apple_company_id}/brands', 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.gmbapi.com/external-api/gmb/oauth/apple/companies/{apple_company_id}/brands",
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.gmbapi.com/external-api/gmb/oauth/apple/companies/{apple_company_id}/brands"
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.gmbapi.com/external-api/gmb/oauth/apple/companies/{apple_company_id}/brands")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gmbapi.com/external-api/gmb/oauth/apple/companies/{apple_company_id}/brands")
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{
"success": true,
"payload": {
"apple_company_id": "COMPANY123",
"brands": [
{
"apple_brand_id": "BRAND123",
"name": "Example Brand",
"brand_name": "Example Brand",
"country_code": "US",
"categories": [
"dining.restaurant",
"dining.cafe"
],
"website_url": "https://example.com",
"app_store_url": null,
"ownership_type": "BRAND_OWNER",
"connected": true,
"segment_id": "brand-550e8400-e29b-41d4-a716-446655440000",
"account_id": "123"
},
{
"apple_brand_id": "BRAND456",
"name": "Unlinked Brand",
"brand_name": "Unlinked Brand",
"country_code": "DE",
"categories": [
"dining.cafe"
],
"website_url": null,
"app_store_url": null,
"ownership_type": null,
"connected": false,
"segment_id": null,
"account_id": null
}
]
}
}{
"error": 123,
"message": "<string>"
}{
"error": 123,
"message": "<string>"
}{
"error": 123,
"message": "<string>"
}{
"error": 123,
"message": "<string>"
}Restricted endpoint. Apple Business Connect endpoints are only available to billing accounts that have been explicitly granted access by the GMBapi team. Calling this endpoint without that permission returns
403 Forbidden with APPLE_API_DISABLED. Contact GMBapi support if you need access.Requires an Organization token. Calling this endpoint with an Account token returns
403 Forbidden (Authorization level not found).apple_company_id comes from the OAuth callback company_id or from Get Apple OAuth Status.
This is not List Apple Brands. That endpoint returns brand segments already stored in GMBapi. This one returns Apple’s own brands, including ones that are not linked yet.
Pass the apple_brand_id values you want to link to Connect Apple Company Brands.
Brand fields
| Field | Meaning |
|---|---|
apple_brand_id | Apple Business Connect brand id. |
name, brand_name | Display name from Apple. Both are set to the same value. |
country_code | ISO 3166-1 alpha-2 code from Apple, or null. |
categories | Apple taxonomy ids, verbatim (not Google gcids). The first value is the primary category. |
website_url, app_store_url | Homepage and iOS app URLs from Apple, or null. |
ownership_type | BRAND_OWNER or FRANCHISEE, or null when Apple omits it. |
connected | true when a brand segment already exists for this Apple brand. |
segment_id | That segment’s id when connected is true; otherwise null. |
account_id | Account (location group) the existing segment belongs to when connected is true; otherwise null. |
Responses
| Status | Meaning |
|---|---|
200 | Live brand list for the company. |
400 | apple_company_id is blank. |
404 | The company is not connected to this organization (Apple company not found). |
| Apple’s status | Apple rejected the brand list. The response status and body are Apple’s, not a generic 500. |
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Apple Business Connect company id already linked to the organization.