Sign in

v1

latestOpenAPI 3.0.12026-07-243686491.1 MB
Teams

Retrieve a team's settings

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

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

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

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

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

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,
  "showMembersOnApp": true,
  "onboardingSteps": [
    {
      "step": "SETUP_CHARGING_RULE",
      "config": "scheduled"
    }
  ]
}