Get Entity Locations

GET

https://api.runcaptain.com/v2/datasets/odyssey/general/:entity_id/locations

GET

/v2/datasets/odyssey/general/:entity_id/locations

1 import requests
2 import json
3 
4 BASE_URL = "https://api.runcaptain.com"
5 API_KEY = "your_api_key"
6 ORG_ID = "your_organization_id"
7 ENTITY_ID = "your_entity_id"  # Get this from /general/search
8 
9 headers = {
10     "Authorization": f"Bearer {API_KEY}",
11     "X-Organization-ID": ORG_ID
12 }
13 
14 # You can also pass a domain (e.g., "openai.com") or name instead of entity_id
15 response = requests.get(
16     f"{BASE_URL}/v2/datasets/odyssey/general/{ENTITY_ID}/locations",
17     headers=headers,
18     timeout=30.0
19 )
20 
21 data = response.json()
22 print(json.dumps(data, indent=2))

1 {
2   "entity_id": "019cb8ac-adee-749e-a75e-a1c236f20f72",
3   "locations": [
4     {
5       "name": "OpenAI Headquarters",
6       "city": "San Francisco",
7       "state": "California",
8       "country": "United States",
9       "is_headquarters": true
10     }
11   ],
12   "total_count": 1
13 }

Get office locations for any entity. Returns headquarters and branch office addresses with city, state, country, and full address details.

Authentication

AuthorizationBearer

Bearer token authentication using API key

Path parameters

entity_idstringRequired

Response

Successful response

entity_idstring

Entity identifier

locationslist of objects

total_countinteger

Total number of locations

Errors

401

Unauthorized Error

404

Not Found Error

Authentication

Path parameters

Headers

Response

Errors