Properties

Get all user groups associated with a property

get/properties/{id}/user-groups

Request

  • Base URL: https://api.heycharge.com/v1/b2b
  • URL: https://api.heycharge.com/v1/b2b/properties/{id}/user-groups
  • Auth: HTTP bearer

Path parameters

idstring required

Property ID

Headers

b2bidstring

BackofficeAdmin only. Specifies the target B2B ID when acting on behalf of a B2B. For regular users this header is ignored — the B2B from the JWT is always used.

Response

An array of user group models

idstring
propertyIdstring
namestring
colorstring
userIdsstring[]

IDs of users belonging to this group.

chargerIdsstring[]

IDs of chargers assigned to this group.

planIdstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.