/v1/location/{domain} GET
Returns a single location
Locations
Request URL
https://api.to.co/v1/location/{domain}?api_key={your_api_key}
Request Parameters
Key | Type | Required | Description | Example |
---|---|---|---|---|
domain | string | Required | Domain name of the location ending .to.co | "xyz1234.loc.us.to.co" |
Responses
Success (200)
Schema: LocationGetResponse
{ "location": { "address_verified": true, "name": "John Lewis & Partners", "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" } }, "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" }