---
title: "Retrieve a list of teams"
method: GET
path: "/api/v1/teams"
tags: ["Teams"]
---

# Retrieve a list of teams

`GET /api/v1/teams`

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

## Query parameters

- `page` integer
- `perPage` integer
- `partnerExternalId` string, nullable — Filter teams by partnerExternalId, to filter only resources without `partnerExternalId` *use* `partnerExternalId=""`
- `operatorId` integer, 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
- `featureGroupId` integer, nullable — Filter teams by featureGroupId
- `fromUpdatedAt` string, date-time, nullable — Filter to retrieve teams where `updatedAt` >= `fromUpdatedAt` (ISO8601: yyyy-MM-ddTHH:mm:ssZ)
- `includeDeleted` boolean — Filter to include delete teams in the response
- `ids` string, nullable — Filter teams by a comma-separated list of team `id`s

## Response `200`

List of teams that match the criteria

- OffsetBasedResponse33
  - `data` Team[], required
    - `id` integer, required — Id of the team
    - `name` string, required — Name of the team
    - `email` string, nullable — Email of the team that will receive team communications. Named "contact email" in the creation/update APIs.
    - `financeEmail` string, nullable — Finance email of the team that will receive finance related emails
    - `legalEmail` string, nullable — Legal email of the team (certified e-mail)
    - `externalId` string, nullable — External id of the team
    - `partnerExternalId` string, nullable — External Id of this entity, managed by you.
    - `partnerCustomPayload` object[], nullable — Custom JSON payload for this entity, managed by you.
    - `joinCode` string, required — Code to share with a user to join the team
    - `recipientCode` string, nullable — The recipient code used for e-invoicing
    - `companyName` string, nullable — The company name for the given team
    - `taxIdentificationNumber` string, nullable — The tax identification number for the given team
    - `vatNumber` string, nullable — The VAT number for the given team
    - `companyRegistrationNumber` string, nullable — The company registration number for the team
    - `operator` Operator
      - `id` integer — ID of the operator
      - `name` string, required — Name of operator
      - `identifier` string, required — Identifier of operator
      - `partnerId` integer, nullable — Id of the partner
      - `vatNumber` string, nullable — VAT number
    - `address` TeamDtoTeamAddressDto, required
      - `address1` string, nullable — First line of address
      - `address2` string, nullable — Second line of address
      - `address3` string, nullable — Third line of address
      - `city` string, nullable — The address city
      - `province` string, nullable — The address province
      - `zipCode` string, nullable — The address zip code
      - `countryId` integer — The address country
    - `currency` Currency1, required
      - `identifier` string, required — Currency identifier, e.g. dkk
      - `name` string, required — Readable name of currency
      - `decimals` integer — Number of decimals for this currency
    - `type` 'private' | 'professional' | 'operator', required — Type of the team
    - `category` TeamDtoTeamCategoryDto
      - `identifier` string, required — Category Identifier
      - `name` string, required — Category name
    - `operatorId` integer, nullable — Deprecated (will be removed by 01.04.24), use `operator` field instead.
    - `userId` integer, required — Id of the user that owns this team
    - `isFrozen` boolean, required — Whether the team is frozen or not
    - `frozenReason` string, nullable — Team freezing reason
    - `featureGroupId` integer, nullable — Feature group id assigned to team
    - `frozenAt` string, date-time, nullable — Frozen date of this team
    - `blockedAt` string, date-time, nullable — Blocked date of this team
    - `createdAt` string, date-time, required — Creation date of this team
    - `updatedAt` string, date-time, required — Update date of this team
    - `deletedAt` string, date-time, nullable — The deleted date of this team
    - `paymentMethod` 'invoice' | 'operator_transaction' | 'source' | 'unknown', required
    - `invoiceRequest` InvoiceRequest
      - `id` integer, required — Id of the invoice request
      - `status` 'pending' | 'approved' | 'rejected', required — Status of the invoice request
      - `requestedAt` string, date-time, required — The timestamp when the invoice request was created
      - `approvedAt` string, date-time, nullable — The timestamp when the invoice request was approved
      - `rejectedAt` string, date-time, nullable — The timestamp when the invoice request was rejected
      - `rejectionReason` string, nullable — The reason for rejecting the invoice request
      - `updatedAt` string, date-time, nullable — The timestamp when the invoice request was last updated
    - `themeId` integer, nullable — The theme id associated with the team.
    - `tags` TeamDtoTeamTagDto[] — Tags associated with this team
      - `id` integer — Tag id
      - `name` string, required — Tag identifier
    - `onboardingSteps` OnboardingStep[], nullable — The onboarding steps enabled for the team, as {step, config?} entries. Returned on the single-team read.
      - `step` 'ADD_VEHICLE' | 'ADD_PAYMENT_METHOD' | 'ADD_RFID' | 'ADD_CHARGER' | 'ADD_TEAM_MEMBER' | 'SETUP_CHARGING_RULE' | 'SETUP_REIMBURSEMENT', required — The onboarding step key. Present in the list means the step is enabled for the team.
      - `config` 'scheduled' | 'smart', nullable — Optional per-step configuration, interpreted by the step. Only SETUP_CHARGING_RULE carries config today: one of `scheduled`, `smart`. Null/absent for all other steps.
  - `meta` MontaPageMeta, required
    - `itemCount` integer, required
    - `currentPage` integer, required
    - `perPage` integer, required
    - `totalPageCount` integer, required
    - `totalItemCount` integer, required

## Other responses

- `400` — The request is invalid
- `401` — Consumer with provided credentials was not found
- `403` — Operator doesn't have access to resource
- `404` — Entity with the provided id was not found

---

[API](https://skmtc.net/monta/apis/monta-partner-api.md) · [All operations](https://skmtc.net/monta/apis/monta-partner-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/monta/monta-partner-api/versions/517e18f11015/schema)