v1

latestOpenAPI 3.0.12026-07-243686491.1 MB

Teams

Retrieve a list of teams

Required scope: teams:read </br>Organization authorization: supported

get/api/v1/teams

Query parameters

pageinteger

page number to retrieve (starts with 0)

perPageinteger

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

partnerExternalIdstring nullable

Filter teams by partnerExternalId, to filter only resources without partnerExternalId use partnerExternalId=""

Example:1

operatorIdinteger nullable

Filter teams by operatorId</br>*Note:*The operatorId must be in the consumer’s operatorIds or, if empty, belong to the organization’s sub-operators

Example:1

featureGroupIdinteger nullable

Filter teams by featureGroupId

Example:1

fromUpdatedAtstring date-time nullable

Filter to retrieve teams where updatedAt >= fromUpdatedAt (ISO8601: yyyy-MM-ddTHH:mm:ssZ)

Example:2022-05-22T09:30:03Z

includeDeletedboolean

Filter to include delete teams in the response

idsstring nullable

Filter teams by a comma-separated list of team ids

Example:13,14,15

Response

List of teams that match the criteria

Example response

{
  "data": [
    {
      "id": 1,
      "name": "Internal team",
      "email": "email@it.com",
      "financeEmail": "email@it.com",
      "legalEmail": "email@it.com",
      "externalId": "123-ABC",
      "partnerExternalId": "ACME-12345",
      "joinCode": "my-team-123",
      "recipientCode": "my-team-123",
      "companyName": "Housing XYZ",
      "taxIdentificationNumber": "123456789",
      "vatNumber": "DE123456789",
      "companyRegistrationNumber": "13585628",
      "operator": {
        "id": 14,
        "name": "Monta",
        "identifier": "monta",
        "partnerId": 1,
        "vatNumber": "FOO-123-ABC"
      },
      "address": {
        "address1": "Strandboulevarden 122",
        "address2": "København",
        "address3": "5. sal",
        "city": "Berlin",
        "province": "Lombardy",
        "zipCode": "10011",
        "countryId": 1
      },
      "currency": {
        "identifier": "dkk",
        "name": "Danish krone",
        "decimals": 2
      },
      "type": "personal",
      "category": {
        "identifier": "cpo",
        "name": "Charge Point Operator"
      },
      "operatorId": 1,
      "userId": 1,
      "frozenReason": "removed team",
      "featureGroupId": 1,
      "frozenAt": "2022-05-12T16:56:45.99Z",
      "blockedAt": "2022-05-12T15:56:45.99Z",
      "createdAt": "2022-05-12T15:56:45.99Z",
      "updatedAt": "2022-05-12T16:56:45.99Z",
      "deletedAt": "2022-05-12T16:56:45.99Z",
      "invoiceRequest": {
        "id": 12345,
        "status": "pending",
        "requestedAt": "2025-07-08T15:56:45.99Z",
        "approvedAt": "2025-07-08T16:00:00Z",
        "rejectedAt": "2025-07-08T16:05:00Z",
        "rejectionReason": "Missing required data",
        "updatedAt": "2025-07-08T16:10:00Z"
      },
      "themeId": 1,
      "tags": [
        {
          "id": 1,
          "name": "cpo"
        }
      ],
      "onboardingSteps": [
        {
          "step": "SETUP_CHARGING_RULE",
          "config": "scheduled"
        }
      ]
    }
  ]
}