v1

latestOpenAPI 3.0.12026-07-243686491.1 MB

Team Members

Retrieve a team member.

Required scope: team-members:read Organization authorization: supported

get/api/v1/team-members/{id}

Path parameters

idinteger required

Response

Team member with provided id

idinteger required

Id of the team member

teamIdinteger

Team id of team member

displayNamestring nullable

The team member display name, formats can be: First and Last Name, User: #id, email, or phone

partnerExternalTeamIdstring nullable

The partner external id for the team

userIdinteger nullable

User id of team member. If the user does not exist yet, it will be null

emailstring nullable

Email of the team member

phonestring nullable

Phone number of the team member

role'admin' | 'user' | 'other' required

access'all' | 'selected' | 'other' required

definitions:

all - Indicates the team member has access all the team's charge points.
selected - Indicates the team member has only access to the selected charge points.
other - Fallback value, Indicates a new type was added but is not mapped/unknown on this API yet.

notestring nullable

Note for team member

invitedAtstring date-time nullable

Date of team member was invited to join the team

invitedBystring nullable

Email of the team member that invited this team member

acceptedAtstring date-time nullable

Date of team member accepted the invitation

acceptedBystring nullable

Email of the team member that accepted the invitation

rejectedAtstring date-time nullable

Date of team member rejected the invitation

createdAtstring date-time nullable

Date the team member was created

updatedAtstring date-time nullable

Date the team member was updated

deletedAtstring date-time nullable

Date the team member was deleted

chargePointIdsinteger[] required

The charge points ids this team member has access

priceGroupIdinteger nullable

The price group for this team member

costGroupIdinteger nullable

The cost group for this team member

teamMemberProfileIdinteger nullable

The team member profile id to apply to this team member

canConfigureChargePointsboolean

Indicates if the team member can configure charge points

canPayWithTeamWalletboolean

Indicates if the team member can pay with the team wallet in the Monta shop (e.g. charge keys, stickers). Team wallet payment for charging sessions is controlled by teamWalletChargePaymentType

canManageTeamWalletboolean

Indicates if team member has access to withdraw and deposit from your team wallet to your bank account

canDepositToWalletboolean nullable

Indicates if team member can deposit to team wallet

canWithdrawFromWalletboolean nullable

Indicates if team member can withdraw from team wallet

canManageChargeKeysboolean nullable

Indicates if team member can manage charge keys for the team

canRequestSponsoringboolean

Indicates if the team member is allowed to request sponsoring from this team for their charge point

canManageTeamMembersboolean

Indicates that the team member can view and manage other members settings

canPayForChargesCountryIdsinteger[] required

List of country ids for which the team member can pay for charges

On which chargers is the team member allowed to pay with Team Wallet? * all - On any charger (including roaming chargers) * partner - On chargers with the same partner as this team * operator - On chargers with the same operator as this team * team - On chargers belonging to this team * selected_operators - On chargers from selected operators * none - The team member is not allowed to pay with Team Wallet for any charge session

partnerExternalIdstring nullable

External Id of this entity, managed by you

partnerCustomPayloadobject[] nullable

Custom JSON payload for this entity, managed by you

kwhPriceCapAcnumber nullable

Maximum price per kWh in the team currency that the team will cover when charging on AC.

kwhPriceCapDcnumber nullable

Maximum price per kWh in the team currency that the team will cover when charging on DC.

sponsoredPriceGroupIdinteger nullable

Price group used to reimburse this team member for home charging. null means the employee's own cost price group is cloned at SCP creation time.

autoApproveElectricityCostboolean

When true, employee-submitted electricity costs are auto-approved for SCPs created for this team member.

reimbursementEnabledboolean

Master switch — whether the team member participates in home reimbursement. Gates auto-creation of sponsored charge points on acceptance and on charge-point install.

reimbursementPayoutSchedule'end-of-month' | 'realtime' | 'other'

reimbursementSubscriptionboolean

Whether the operator reimburses the charge-point subscription price for this team member.

Example response

{
  "id": 1,
  "teamId": 42,
  "displayName": "Casper Rasmussen",
  "operator": {
    "id": 14,
    "name": "Monta",
    "identifier": "monta",
    "partnerId": 1,
    "vatNumber": "FOO-123-ABC"
  },
  "partnerExternalTeamId": "A1B2C3BE3121",
  "userId": 1,
  "email": "example@monta.com",
  "phone": "+4512345678",
  "note": "A Note",
  "invitedAt": "2022-05-12T15:56:45.99Z",
  "invitedBy": "example@monta.com",
  "acceptedAt": "2022-05-12T15:56:45.99Z",
  "acceptedBy": "example@monta.com",
  "rejectedAt": "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",
  "priceGroupId": 1,
  "costGroupId": 1,
  "teamMemberProfileId": 1,
  "canPayForChargesCountryIds": [
    1,
    2,
    3
  ],
  "teamWalletChargePaymentType": "none",
  "partnerExternalId": "ACME-12345",
  "kwhPriceCapAc": 2.5,
  "kwhPriceCapDc": 5,
  "sponsoredPriceGroupId": 1
}