MOmonta
Operator Lists

Retrieve a list of operator lists

Changed on

Retrieves a paginated list of the operator's lists. Required scope: operator-lists:read </br>Organization authorization: supported

get/api/v1/operator-lists

Request

  • Base URL
    https://partner-api.monta.com
  • URL
    https://partner-api.monta.com/api/v1/operator-lists
  • Auth
    HTTP bearer

Query parameters

searchstring

Free-text search filter by list name. Max 255 characters.

list_types'user' | 'team' | 'charge_point' | 'charge_points_public' | 'site' | 'charge_key' | 'vehicle'

Filter by list type. Multiple values supported (repeat the parameter).

pageinteger

Page number to retrieve (starts with 0)

perPageinteger

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

Response

List of operator lists that match the criteria

Example response

{
  "data": [
    {
      "id": 1,
      "operatorId": 42,
      "name": "VIP customers",
      "description": "Customers eligible for discounted charging",
      "source": "partner",
      "listType": "user",
      "itemCount": 12,
      "itemCounts": {
        "user": 8,
        "team": 4
      },
      "createdByUserId": 20,
      "createdAt": "2024-03-16T15:37:23Z",
      "updatedAt": "2024-03-16T15:37:23Z",
      "syncMode": "AUTO",
      "lastSyncedAt": "2024-03-16T15:37:23Z",
      "lastSyncStatus": "COMPLETED",
      "pendingSyncRun": {
        "id": 1,
        "listId": 42,
        "status": "COMPLETED",
        "trigger": "MANUAL",
        "matchedCount": 120,
        "addedCount": 5,
        "removedCount": 2,
        "errorMessage": "Search is unavailable; please retry.",
        "entityIdsByOutcome": {
          "matched": [
            1,
            2,
            3
          ],
          "added": [
            3
          ]
        }
      }
    }
  ]
}

Changes