LogoLogo
HomeDiscordConnect
URnetwork API Docs
URnetwork API Docs
  • Getting Started
  • About
  • API reference
    • Preferences
      • Set preferences
    • Hello
    • Stats
      • Last 90
      • Providers overview last 90
      • Providers
      • Provider last 90
    • Auth
      • Login
      • Login with password
      • Verify
      • Verify send
      • Password reset
      • Password set
      • Network check
      • Network create
      • Code create
      • Code login
    • Network
      • Auth client
      • Remove client
      • Clients
      • Provider locations
      • Find provider locations
      • Find locations
      • Find providers
      • Find providers2
      • Create provider spec
    • Feedback
      • Send feedback
    • Wallet
      • Balance
      • Validate address
      • Circle init
      • Circle transfer out
    • Subscription
      • Balance
      • Check balance code
      • Redeem balance code
      • Create payment id
    • Device
      • Add
      • Create share code
      • Share status
      • Confirm share
      • Create adopt code
      • Adopt status
      • Confirm adopt
      • Remove adopt code
      • Associations
      • Remove association
      • Set association name
      • Set name
      • Set provide
      • Share code
        • Qr.png
      • Adopt code
        • Qr.png
    • Connect
      • Control
    • Account
      • Payout wallet
      • Wallet
      • Wallets
        • Remove
      • Referral code
    • Transfer
      • Stats
  • Specification
Powered by GitBook
LogoLogo

URnetwork

  • Get the app
  • Docs
  • Feedback
  • Support

Copyright 2024 BringYour, Inc.

On this page

Was this helpful?

Export as PDF
  1. API reference
  2. Network

Provider locations

PreviousClientsNextFind provider locations

Was this helpful?

get

A list of locations and groups where there are at least one active provider in good health. Note that a location or group will need to be mapped to an actual provider using /network/find-providers.

Responses
200Success
application/json
get
GET /network/provider-locations HTTP/1.1
Host: api.bringyour.com
Accept: */*
200Success
{
  "specs": [
    {
      "location_id": "text",
      "location_group_id": "text",
      "client_id": "text",
      "best_available": true
    }
  ],
  "groups": [
    {
      "location_group_id": "text",
      "name": "text",
      "provider_count": 1,
      "promoted": true,
      "match_distance": 1
    }
  ],
  "locations": [
    {
      "location_id": "text",
      "location_type": "city",
      "name": "text",
      "city": "text",
      "city_location_id": "text",
      "region": "text",
      "region_location_id": "text",
      "country": "text",
      "country_location_id": "text",
      "country_code": "text",
      "provider_count": 1,
      "match_distance": 1
    }
  ],
  "devices": [
    {
      "client_id": "text",
      "device_name": "text"
    }
  ]
}