# Google Business Profile Locations (`google-business.locations`)

Lists the business locations of a Business Profile account: name, address, phone, categories, website, open status and Maps links.

Docs: https://primaryapi.com/docs/api-reference/google-business/locations

- Endpoint: `POST https://api.primaryapi.com/v1/run/google-business.locations`
- Category: Search & SEO · Platform: `google-business` · Kind: list · Status: live
- Price: 1 credit per call. Every call costs the same, including calls that were retried automatically.
- Billing unit: per successful call
- Reliability: routed to a healthy upstream and retried automatically when an attempt fails; live 30-day status: `GET https://api.primaryapi.com/v1/status/apis?sku=google-business.locations`
- Execution: synchronous (answers 202 only if it outlives the wait window)

## Input

| Field | Type | Required | Default | Constraints | Description |
|---|---|---|---|---|---|
| `accountId` | string | yes |  | pattern: ^(?:accounts\/)?([A-Za-z0-9_-]{1,64})$ | Business Profile account id, e.g. "1234567890" (or "accounts/1234567890"), as google-business.accounts lists it. |
| `orderBy` | enum | no |  | one of: title, storeCode | Sort by business name (title) or your store code; Google’s default order when omitted. |
| `limit` | integer | no | 50 | 1–100 | Maximum number of results to return (1-100, default 50). |
| `cursor` | string | no |  |  | Opaque pagination cursor: pass the previous response's nextCursor. |
| `connection` | string | no |  | max 200 chars | Which connected account to use when the workspace has several for this provider: the customId you gave it (exact), its connection id ("con_…"), its handle (login, email or @handle) or its name. Optional; prefer the customId or id, which never match two accounts. |

Unknown fields are rejected with `400 invalid_input`. The routing controls `preferLatencyUnderMs` and `maxCredits` may be sent in the same JSON body.

## Output

When `output.found` is `true`, `output.data` has this shape:

| Field | Type | Description |
|---|---|---|
| `accountId` | string |  |
| `locations` | object[] |  |
| `locations[].locationId` | string | Pass this as locationId to google-business.reviews, .performance and .search_keywords |
| `locations[].accountId` | string | The account it was listed under (pass it with locationId to google-business.reviews) |
| `locations[].name` | string | Resource name, "locations/9876543210" |
| `locations[].title` | string \| null | The business name |
| `locations[].storeCode` | string \| null |  |
| `locations[].languageCode` | string \| null |  |
| `locations[].primaryPhone` | string \| null |  |
| `locations[].additionalPhones` | string[] |  |
| `locations[].primaryCategory` | object \| null |  |
| `locations[].primaryCategory.id` | string \| null |  |
| `locations[].primaryCategory.name` | string \| null |  |
| `locations[].additionalCategories` | object[] |  |
| `locations[].additionalCategories[].id` | string \| null |  |
| `locations[].additionalCategories[].name` | string \| null |  |
| `locations[].address` | object \| null | The storefront address (null for a service-area business without one) |
| `locations[].address.addressLines` | string[] |  |
| `locations[].address.locality` | string \| null |  |
| `locations[].address.administrativeArea` | string \| null |  |
| `locations[].address.postalCode` | string \| null |  |
| `locations[].address.regionCode` | string \| null | CLDR country/region code, e.g. "US" |
| `locations[].websiteUri` | string \| null |  |
| `locations[].openStatus` | string \| null | OPEN, CLOSED_PERMANENTLY or CLOSED_TEMPORARILY |
| `locations[].description` | string \| null |  |
| `locations[].labels` | string[] |  |
| `locations[].placeId` | string \| null | Google Maps place id, when the location appears on Maps |
| `locations[].mapsUri` | string \| null |  |
| `locations[].newReviewUri` | string \| null | Link where customers can leave a review |
| `locations[].hasVoiceOfMerchant` | boolean \| null | False when the profile is not (or no longer) verified |
| `locations[].hasPendingEdits` | boolean \| null |  |
| `nextCursor` | string \| null |  |

When the thing you asked about does not exist (or a search matches nothing) the call still succeeds: `output.found` is `false`, `output.data` is `null` and `output.reason` says why (`not_found`, `private`, `no_results`, …). Misses are free unless the notes below say misses are billed.

Pagination: pass the previous response’s `nextCursor` as `cursor` to get the next page; `nextCursor: null` means there are no more results.

## Example request

```bash
curl -sS -X POST "https://api.primaryapi.com/v1/run/google-business.locations" \
  -H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"accountId":"2345678901","limit":1}'
```

## Example response

_Values are placeholders that follow the output schema; `credits` is what this call would cost at the usual price._

```json
{
  "output": {
    "found": true,
    "data": {
      "accountId": "2345678901",
      "locations": [
        {
          "locationId": "9876543210",
          "accountId": "2345678901",
          "name": "locations/9876543210",
          "title": "Example Coffee",
          "storeCode": "SF-01",
          "languageCode": "en",
          "primaryPhone": "+1 415-555-0132",
          "additionalPhones": [],
          "primaryCategory": {
            "id": "categories/gcid:coffee_shop",
            "name": "Coffee shop"
          },
          "additionalCategories": [
            {
              "id": "categories/gcid:cafe",
              "name": "Cafe"
            }
          ],
          "address": {
            "addressLines": [
              "1 Market St"
            ],
            "locality": "San Francisco",
            "administrativeArea": "CA",
            "postalCode": "94103",
            "regionCode": "US"
          },
          "websiteUri": "https://coffee.example.com/",
          "openStatus": "OPEN",
          "description": "Small-batch coffee roasted in the Mission.",
          "labels": [],
          "placeId": "ChIJexample0000000000000",
          "mapsUri": "https://maps.google.com/maps?cid=1234567890123456789",
          "newReviewUri": "https://search.google.com/local/writereview?placeid=ChIJexample0000000000000",
          "hasVoiceOfMerchant": true,
          "hasPendingEdits": null
        }
      ],
      "nextCursor": "eyJ0IjoiQ0FFUUFRIn0"
    }
  },
  "provider": "PrimaryAPI",
  "credits": 1,
  "items": 1,
  "requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z",
  "nextCursor": null
}
```

## Pricing and reliability

- Usual price: 1 credit per call
- Price ceiling: the usual price, even when a call is retried. A quote’s `maxCredits` is the most a given call can cost; the `maxCredits` routing control caps it per call
- Live 30-day status, success rate, uptime and latency: `GET https://api.primaryapi.com/v1/status/apis?sku=google-business.locations`

## Errors to handle

`invalid_input`, `unauthorized`, `insufficient_balance`, `key_limit_reached`, `trial_cap_reached`, `forbidden`, `not_found`, `idempotency_conflict`, `rate_limited`, `all_sources_failed`, `service_unavailable`, `timeout`. See https://primaryapi.com/docs/errors.

## Notes

Runs as your connected Google account and needs the Google Business Profile capability (business_profile). Get accountId from google-business.accounts. A personal account lists only the locations it owns directly; locations shared through a location group or organization are listed under that account. An account with no locations is a miss (no_locations), an unknown account account_not_found. Google grants Business Profile API access per Cloud project, on request: until it has granted PrimaryAPI’s, calls are refused (as a permission error, never charged).

