Sign in

v1

latestOpenAPI 3.0.12026-07-243686491.1 MB
Team Members

Retrieve a list of team members.

Required scope: team-members:read </br>Organization authorization: supported

get/api/v1/team-members

Query parameters

pageinteger

page number to retrieve (starts with 0)

perPageinteger

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

teamIdinteger nullable

Filter team members by teamId

Example:1
includeDeletedboolean

Includes deleted resources in the response

Example:true
role'admin' | 'user' | 'other'
state'requested' | 'invited' | 'rejected' | 'accepted' | 'blocked' | 'expired' | 'other'
userIdinteger nullable

Filter team members with specified userId

Example:42
emailstring email nullable

Filter team members with specified email

Example:user@acme.com
phonestring nullable

Filter team members with specified phone number

Example:+451234567
partnerExternalTeamIdstring nullable

Filter team members by the specified partnerExternalTeamIdNote: partnerExternalTeamId refers to external id on the team level

Example:1A2B3C4D5E
partnerExternalIdstring nullable

Filter team members with specified partnerExternalId

Example:1A2B3C4D5E

Response

List of team members that match the criteria

Example response

{
  "data": [
    {
      "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
    }
  ]
}