Teams

Retrieve a team's settings

Changed on

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

get/api/v1/teams/{id}/settings

Request

  • Base URL
    https://partner-api.monta.com
  • URL
    https://partner-api.monta.com/api/v1/teams/{id}/settings
  • Auth
    HTTP bearer

Path parameters

idinteger required

Response

Settings for the team with the provided id

teamIdinteger required

Id of the team these settings belong to

customerTypestring nullable

Customer type of the team

invoicePeriodstring nullable

Invoicing period for the team

invoiceWithdrawboolean required

Whether team balance is withdrawn via invoice. Mutually exclusive with autoWithdrawEnabled.

invoiceDestinationCodestring nullable

Destination code used on team invoices

poNumberstring nullable

Purchase order number applied to team invoices

eanNumberstring nullable

EAN/CIF number of the team

partnerExternalIdstring nullable

External id assigned to the team by the partner

joinCodestring required

Code used to join the team

selfRegisterChargeKeysboolean required

Whether members can self-register charge keys for this team

inventoryOnlyChargeKeysboolean

Whether the team is restricted to only charge keys that are in the operator inventory

autoAcceptInvitationRequestsboolean required

Whether team join requests are accepted automatically

autoGenerateChargePointGroupsboolean required

Whether charge point groups are generated automatically for the team

showMembersOnAppboolean required

Whether team members are shown in the app

onboardingProfileIdinteger nullable

The onboarding profile the team is locked to; null when its steps are set directly.

autoWithdrawEnabledboolean

Whether automatic bank withdrawal is on for the team (equivalent to autoWithdrawNextAt being set). Mutually exclusive with invoiceWithdraw, but legacy teams can have both set, so check invoiceWithdraw as well. Change it with autoWithdraw on PATCH /teams/{id}.

autoWithdrawNextAtstring date-time nullable

When the next automatic withdrawal is due; null when automatic withdrawal is off.

Example response

{
  "teamId": 12,
  "customerType": "FLEET_DRIVER",
  "invoicePeriod": "monthly",
  "invoiceWithdraw": true,
  "invoiceDestinationCode": "DK12345",
  "poNumber": "PO-123",
  "eanNumber": "5790000000000",
  "partnerExternalId": "partner-team-1",
  "joinCode": "ABC123",
  "selfRegisterChargeKeys": true,
  "inventoryOnlyChargeKeys": true,
  "showMembersOnApp": true,
  "onboardingSteps": [
    {
      "step": "SETUP_CHARGING_RULE",
      "config": "scheduled",
      "displayMode": "full_screen"
    }
  ],
  "onboardingProfileId": 12,
  "onboardingWelcomeText": {
    "type": "home",
    "enabled": true
  },
  "autoWithdrawEnabled": true,
  "autoWithdrawNextAt": "2026-11-01T00:00:00Z"
}

Changes

    • warning

      added the new admin enum value to the // response property for the response status

    • warning

      added the new member enum value to the // response property for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status