v1

latestOpenAPI 3.0.12026-07-243686491.1 MB

Team Member Profiles (Member Groups)

Retrieve a list of team member profiles (member groups)

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

get/api/v1/team-member-profiles

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 member profiles by teamId

Example:1

namestring nullable

Filter team member profiles by the specified name

Example:expired

Response

List of team member profiles (Member group) that match the criteria

Example response

{
  "data": [
    {
      "id": 1,
      "teamId": 42,
      "name": "Example profile 1",
      "description": "description",
      "priceGroupId": 1,
      "costGroupId": 1,
      "teamWalletChargePaymentType": "none",
      "canPayForChargesCountryIds": [
        1,
        2,
        3
      ],
      "operator": {
        "id": 14,
        "name": "Monta",
        "identifier": "monta",
        "partnerId": 1,
        "vatNumber": "FOO-123-ABC"
      },
      "createdAt": "2022-05-12T15:56:45.99Z",
      "updatedAt": "2022-05-12T16:56:45.99Z",
      "deletedAt": "2022-05-12T16:56:45.99Z",
      "kwhPriceCapAc": 2.5,
      "kwhPriceCapDc": 5,
      "sponsoredPriceGroupId": 1
    }
  ]
}