List location images​

GET
/locations/{locationId}/images

Returns image metadata for a location, optionally filtered by image category and paginated. The response does not contain the image file bytes.

Use cases

  • Build a location image gallery.
  • Find the image ID before downloading, updating, or deleting it.

Related endpoints

  • POST /locations/{locationId}/images — upload an image.
  • GET /locations/{locationId}/images/{imageId}/download — retrieve the image file.

Authorizations​

bearerAuth

Generate an API token here

Type
HTTP (bearer)

Parameters​

Header Parameters

compatibility-date*

API compatibility date in YYYY-MM-DD format. Must be a date after 2025-11-01.

Type
string
Required
Example"2025-11-02"
Pattern
^\d{4}-\d{2}-\d{2}$
organization-id*

Routes the request to the organization named by this ID. The bearer token must be authorized for that organization.

Type
string
Required
Example"3b241101-e2bb-4255-8caf-4136c566a962"
Min Length
1
Max Length
40

Path Parameters

locationId*

ID returned by POST /locations or GET /locations. It scopes location updates and image operations to one site.

Type
string
Required
Example"2ABCDEFGHJKLMNPQRSTU"
Min Length
1
Max Length
40

Query Parameters

category

Choose the label that best matches the image content:

Category Use for
CHARGER Charger hardware.
ENTRANCE The site entrance or access route.
LOCATION A general view of the site.
NETWORK Charging-network branding.
OPERATOR The site or charging-station operator.
OTHER Content that does not fit another category.
OWNER The site owner.
Type
string
Valid values
"CHARGER""ENTRANCE""LOCATION""NETWORK""OPERATOR""OTHER""OWNER"
Example"LOCATION"
page

1-based page number; defaults to 1.

Type
integer
Example2
Default
1
Exclusive Minimum
0
Maximum
4294967295
per_page

Maximum records returned per page. Defaults to 10 and cannot exceed 100.

Type
integer
Example25
Default
10
Exclusive Minimum
0
Maximum
100

Responses​

success.location.image.list

application/json

Image metadata and relative paths for retrieving each PNG rendition.

Number of images matching the category filter before pagination.

Minimum0
Maximum9007199254740991

Playground​

Authorization
Headers
Variables
Key
Value

Samples​