Skip to main content
GET
/
api
/
v3
/
teams
/
{team_uuid}
/
sites
List sites
curl --request GET \
  --url https://app.plugchoice.com/api/v3/teams/{team_uuid}/sites \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "uuid": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Main Office",
      "address": "Example Street 123, Amsterdam, NL",
      "street": "Example Street",
      "postal_code": "1234AB",
      "house_number": 123,
      "house_number_addition": null,
      "city": "Amsterdam",
      "country": "NL",
      "smart_charging": "disabled",
      "chargers_count": 5,
      "created_at": "2024-01-01T00:00:00.000000Z"
    }
  ],
  "first_page_url": "https://app.plugchoice.com/api/v3/teams/123/sites?page=1",
  "from": 1,
  "next_page_url": "https://app.plugchoice.com/api/v3/teams/123/sites?page=2",
  "path": "https://app.plugchoice.com/api/v3/teams/123/sites",
  "per_page": 25,
  "prev_page_url": null,
  "to": 25,
  "filter_options": {
    "countries": [
      "NL",
      "DE",
      "BE"
    ],
    "smart_charging_modes": [
      "day_ahead_pricing",
      "disabled",
      "off_peak"
    ]
  }
}

Authorizations

​
Authorization
string
header
required

See the documentation for more information.

Path Parameters

​
team_uuid
string
required

Query Parameters

​
filter[search]
string

Filter by site name or address

Example:

"Main Office"

​
filter[country]
string

Filter by country code (e.g., NL, DE, BE)

Example:

"NL"

​
filter[smart_charging]
string

Filter by smart charging mode (disabled, day_ahead_pricing, off_peak)

Example:

"day_ahead_pricing"

​
sort
string

Sort field (name, country, chargers_count, created_at). Prefix with - for descending. Default: name

Example:

"name"

​
page
integer

Page number for pagination

Example:

1

Response

Paginated list of sites with filter options

​
data
object[]
Example:
[
  {
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Main Office",
    "address": "Example Street 123, Amsterdam, NL",
    "street": "Example Street",
    "postal_code": "1234AB",
    "house_number": 123,
    "house_number_addition": null,
    "city": "Amsterdam",
    "country": "NL",
    "smart_charging": "disabled",
    "chargers_count": 5,
    "created_at": "2024-01-01T00:00:00.000000Z"
  }
]
​
first_page_url
string
Example:

"https://app.plugchoice.com/api/v3/teams/123/sites?page=1"

​
from
integer
Example:

1

​
next_page_url
string
Example:

"https://app.plugchoice.com/api/v3/teams/123/sites?page=2"

​
path
string
Example:

"https://app.plugchoice.com/api/v3/teams/123/sites"

​
per_page
integer
Example:

25

​
prev_page_url
string
Example:

null

​
to
integer
Example:

25

​
filter_options
object