/v1/org/{domain}/locations GET
Returns the locations associated with an organization
OrgsLocations
Request URL
https://api.to.co/v1/org/{domain}/locations?api_key={your_api_key}
Request Parameters
Key | Type | Required | Description | Example |
---|---|---|---|---|
domain | string | Required | Domain name of the Org ending .to.co | "unilever.to.co" |
Responses
Success (200)
Schema: OrgGetLocationsResponse
{ "locations": { "total": 1, "results": [ { "address_verified": true, "name": "John Lewis & Partners", "hours": { "normal": [ { "day": 0, "open": false, "open_time": "00:00", "close_time": "00:00" }, { "day": 1, "open": true, "open_time": "09:00", "close_time": "17:00" }, { "day": 2, "open": true, "open_time": "09:00", "close_time": "17:00" }, { "day": 3, "open": true, "open_time": "09:00", "close_time": "17:00" }, { "day": 4, "open": true, "open_time": "09:00", "close_time": "17:00" }, { "day": 5, "open": true, "open_time": "09:00", "close_time": "17:00" }, { "day": 6, "open": false, "open_time": "00:00", "close_time": "00:00" } ], "special": [ { "date": "2025-12-24", "open": true, "open_time": "09:00", "close_time": "16:00" }, { "date": "2025-12-26", "open": true, "open_time": "09:00", "close_time": "16:00" } ] }, "domain": "2hqh3aw8.loc.uk.to.co", "address": { "domain": "yyb7e4pd.a.uk.to.co", "line1": "171 Victoria Street", "line2": "London", "zip": "SW1E 5NN", "country_code": "GB" }, "links": { "facebook_url": "https://www.facebook.com/johnlewisretail", "instagram_url": "https://instagram.com/johnlewis", "linkedin_url": "https://www.linkedin.com/company/johnlewisandpartners/", "tiktok_url": "https://www.tiktok.com/@johnlewis", "twitter_url": "https://twitter.com/JohnLewisRetail", "website_url": "https://www.johnlewis.com/", "youtube_url": "https://www.youtube.com/c/johnlewisandpartners" } } ] }, "request": { "id": "caedc1bd-a4d4-4e18-a904-bac04c31fe85", "success": true, "period_start": "2025-02-03T14:49:40.000Z", "next_period_start": "2025-03-03T14:49:40.000Z", "requests_this_period": 2000, "credit_available_this_period": 10000, "credit_used_this_request": 1, "credit_used_this_period": 2500, "credit_remaining_this_period": 7500, "account_id": "fddb84zz.acct.to.co", "subscription_id": "Az9g3fSwOBwtj2El" } }
Forbidden (403)
Schema: ForbiddenError
{ "code": 403, "message": "Forbidden: Invalid api_key parameter value" }
Not Found (404)
Schema: NotFoundError
{ "code": 404, "message": "Not Found: No Org exists for this domain" }