Skip to main content
GET
/
v3
/
sites
List Locations
curl --request GET \
  --url https://app.plugchoice.com/api/v3/sites \
  --header 'Authorization: Bearer <token>'
{
  "uuid": "<string>",
  "id": 123,
  "name": "<string>",
  "address": "<string>",
  "street": "<string>",
  "postal_code": "<string>",
  "house_number": 123,
  "house_number_addition": "<string>",
  "city": "<string>",
  "country": "<string>",
  "smart_charging": true,
  "chargers_count": 123,
  "capabilities": {
    "smart_charging": true,
    "load_management": {
      "dynamic": true,
      "peak_shaving": true,
      "solar": true
    }
  },
  "created_at": "<string>",
  "updated_at": "<string>",
  "permissions": {
    "basic": true,
    "sensitive": true,
    "full": true
  }
}
Returns a paginated list of locations accessible to the authenticated user.
team
string
Filter locations by team identifier.
Search locations by name or address.

Response

uuid
string
The unique UUID of the location.
id
integer
The numeric ID of the location.
name
string
The name of the location.
address
string
The full formatted address of the location.
street
string
The street name.
postal_code
string
The postal code.
house_number
integer
The house number.
house_number_addition
string
The house number addition (e.g., “A”, “B”). May be null.
city
string
The city name.
country
string
The ISO 3166-1 alpha-2 country code.
smart_charging
boolean
Whether smart charging is enabled for this location.
chargers_count
integer
The number of chargers assigned to this location.
capabilities
object
The location’s available capabilities based on licensing.
created_at
string
ISO 8601 timestamp of when the location was created.
updated_at
string
ISO 8601 timestamp of when the location was last updated.
permissions
object
The authenticated user’s permissions for this location.