Sign in

v1

latestOpenAPI 3.0.12026-07-243686491.1 MB
Nested teams

Retrieve a list of nested team relations

Required scope: team-members:read </br>Organization authorization: supported

get/api/v1/nested-teams

Query parameters

pageinteger

page number to retrieve (starts with 0)

perPageinteger

number of items per page (between 1 and 100, default 10)

state'requested' | 'invited' | 'accepted' | 'rejected_at' | 'blocked' | 'expired'
includeDeletedboolean nullable

Includes deleted resources in the response

nestedTeamIdsstring nullable

Filter by a comma-separated list of nested team ids

Example:21,34
parentTeamIdsstring nullable

Filter by a comma-separated list of parent team ids

Example:7,8
priceGroupIdsstring nullable

Filter by a comma-separated list of price group ids

Example:5,6
invitedByUserIdsstring nullable

Filter by a comma-separated list of inviting user ids

Example:101,102
access'all' | 'selected'

Response

List of nested team relations that match the criteria

Example response

{
  "data": [
    {
      "id": 1,
      "parentTeam": {
        "id": 1,
        "publicName": "Example Team",
        "memberCount": 10
      },
      "nestedTeam": {
        "id": 1,
        "publicName": "Example Team",
        "memberCount": 10
      },
      "priceGroup": {
        "id": 1,
        "name": "Standard Pricing"
      },
      "invitedByUser": {
        "id": 1,
        "firstName": "John",
        "lastName": "Doe",
        "displayName": "johndoe123"
      },
      "userRole": "user",
      "selectedChargePointIds": [
        41,
        72,
        93
      ],
      "note": "Internal note placeholder",
      "createdAt": "2022-07-27T18:11:41Z",
      "updatedAt": "2022-07-28T18:11:41Z",
      "invitedAt": "2022-07-28T18:11:41Z"
    }
  ]
}