Locations

List locations

GET
/extraction/api/locations

All physical locations of an Organization: headquarters and branches, with USPS-standardized addresses, phone and active status. Up to 100 records per page.

Caching: content may not be pre-fetched, cached or stored for more than 7 days. The bq_id itself is exempt.

Guide: Location Extraction API

Authorization

ApiKeyAuth
x-api-key<token>

Your API key, provided by BrightQuery. Contact sales@brightquery.com to get one.

In: header

Query Parameters

bq_id*integer

Unique ID assigned by BrightQuery to the Organization. Get it from a Business Identity or KYB Append search.

Formatint64
page?integer

The page number to retrieve. Each page holds up to 100 records.

Range1 <= value
Default1

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/extraction/api/locations?bq_id=100003273517&page=1"
{  "page": 1,  "records_per_page": 100,  "total_records": 312,  "data": [    {      "bq_location_id": "300018892211",      "bq_id": "100003273517",      "bq_company_name": "FLOWERS FOODS INC",      "bq_location_name": "FLOWERS BAKING CO OF THOMASVILLE",      "bq_location_type": "Branch",      "bq_location_address_line_1": "300 W 4TH ST",      "bq_location_address_city": "THOMASVILLE",      "bq_location_address_state": "GA",      "bq_location_address_zip5": "31792",      "bq_location_active_indicator": 1    }  ]}