v1

latestOpenAPI 3.0.42026-07-241876123.9 KB
Charger

Chargers

Retrieves all chargers accessible by the current user, matching the provided filters.
By default, returns the first 50 items. Use pageIndex for pagination or adjust pageSize (max: 100).

get/api/chargers

Query parameters

Roles0 | 1 | 2 | 4 | 8 | 15 | 16 | 32 | 64 | 128 | 256

0 = None

1 = User

2 = Owner

4 = Maintainer

8 = Administrator

15 = Any

16 = Onboarding

32 = DeviceAdministrator

64 = PartnerAdministrator

128 = Technical

256 = InternalData

Return only charge points where current user has any of the provided user roles. Note that this is a bit-flag and multiple roles can be provided.

0 = None

1 = User

2 = Owner

4 = Maintainer

8 = Administrator

15 = Any

16 = Onboarding

32 = DeviceAdministrator

64 = PartnerAdministrator

128 = Technical

256 = InternalData

DeviceType0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8

0 = Unknown

1 = Smart

2 = Portable

3 = HomeApm

4 = Apollo

5 = OtherApm

6 = GenericApm

7 = HanApm

8 = TicApm

Return only charge points of the provided type.

0 = Unknown

1 = Smart

2 = Portable

3 = HomeApm

4 = Apollo

5 = OtherApm

6 = GenericApm

7 = HanApm

8 = TicApm

InstallationType0 | 1

0 = Pro

1 = Smart

Return only chargers installed in installations of this time.

0 = Pro

1 = Smart

InstallationIdstring uuid

Return only chargers in the specified installation.

NameFilterstring

A filter used to filter items. The filter may be applied to multiple properties depending on the object type.

ReturnIdNameOnlyboolean

If true objects are only returned with their basic properties like Id and name.

SortPropertystring

Name of the property used to sort the result.

SortDescendingboolean

Set to true to sort items in descending order.

PageSizeinteger

Number of items to return per page.

PageIndexinteger

The page index to return, first page is 0.

IncludeDisabledboolean

If true, and your user has access, include disabled objects.

Excludestring[]

Get or set a list of item Id's that will be excluded from the result.

PageInfoOnlyboolean

Returns only information about pages and no data info.

Response

OK

pagesinteger
messagestring nullable