Operator Lists

Retrieve a list of operator lists

GET

https://partner-api.monta.com

/api/v1/operator-lists

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

Retrieve a list of operator lists › query Parameters

search

string · maxLength: 255

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

list_types

string · enum

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

Enum values:

user

team

charge_point

charge_points_public

site

charge_key

vehicle

page

integer · int32

Page number to retrieve (starts with 0)

Default: 0

perPage

integer · int32

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

Default: 10

Retrieve a list of operator lists › Responses

List of operator lists that match the criteria

OffsetBasedResponse_35

OperatorList[] · required

MontaPage.Meta · required

GET/api/v1/operator-lists

curl https://partner-api.monta.com/api/v1/operator-lists \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "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",
      "filterDefinition": {
        "key": {}
      },
      "lastSyncedAt": "2024-03-16T15:37:23Z",
      "lastSyncStatus": "COMPLETED",
      "pendingSyncRun": {
        "id": 1,
        "listId": 42,
        "status": "COMPLETED",
        "trigger": "MANUAL",
        "matchedCount": 120,
        "addedCount": 5,
        "removedCount": 2,
        "proposedCount": 0,
        "excludedSkippedCount": 0,
        "errorMessage": "Search is unavailable; please retry.",
        "startedAt": "startedAt",
        "finishedAt": "finishedAt",
        "createdAt": "createdAt",
        "updatedAt": "updatedAt",
        "entityIdsByOutcome": {
          "matched": [
            1,
            2,
            3
          ],
          "added": [
            3
          ]
        }
      }
    }
  ],
  "meta": {
    "itemCount": 0,
    "currentPage": 0,
    "perPage": 0,
    "totalPageCount": 0,
    "totalItemCount": 0
  }
}

json

application/json

Create an operator list

POST

https://partner-api.monta.com

/api/v1/operator-lists

Required scope: operator-lists:write
Organization authorization: supported

Create an operator list › Request Body

CreateOperatorList

name

string · minLength: 1 · maxLength: 255 · required

Name of the operator list.

Example: VIP customers

listType

string · enum · required

The single entity type this list is restricted to.

Enum values:

user

team

charge_point

charge_points_public

site

charge_key

vehicle

Example: user

description

string | null · maxLength: 65535

Optional free-text description of the operator list.

Example: Customers eligible for discounted charging

source

string · enum

How the list is populated. MANUAL (default) for a hand-curated list, or FILTER for a dynamic list that reconciles from filterDefinition. Immutable after creation.

Enum values:

MANUAL

FILTER

Example: FILTER

syncMode

string · enum

Reconciliation mode for a FILTER list. Only AUTO is supported on the Partner API (changes are applied automatically); defaults to AUTO.

Enum values:

MANUAL

AUTO

Example: AUTO

object | null

Required when source is FILTER: the saved filter the list resolves its members from. Charge-point lists only.

Create an operator list › Responses

Operator list successfully created

OperatorList

id

integer · int64 · required

Id of the operator list.

Example: 1

operatorId

integer · int64 · required

Id of the operator that owns this list.

Example: 42

name

string · required

Name of the operator list.

Example: VIP customers

source

string · required

Origin of the list. partner for lists created via the Monta API.

Example: partner

itemCount

integer · int32 · required

Total number of items in the list.

Example: 12

object · required

Per-entity-type breakdown of the item count, keyed by entity type.

Example: {"user":8,"team":4}

description

string | null

Free-text description of the operator list.

Example: Customers eligible for discounted charging

listType

string | null · enum

The single entity type a homogeneous list is restricted to. null for mixed lists that can hold multiple entity types.

Enum values:

user

team

charge_point

charge_points_public

site

charge_key

vehicle

Example: user

createdByUserId

integer | null · int64

Id of the user who created the list, when known.

Example: 20

createdAt

string | null

When the list was created (ISO-8601).

Example: 2024-03-16T15:37:23Z

updatedAt

string | null

When the list was last updated (ISO-8601).

Example: 2024-03-16T15:37:23Z

syncMode

string | null · enum

Reconciliation mode of a FILTER list; null for a manually-curated list.

Enum values:

MANUAL

AUTO

Example: AUTO

object | null

The saved filter a FILTER-source list resolves its membership from; null for a manual list.

lastSyncedAt

string | null

When the list was last reconciled (ISO-8601); null if it never has been.

Example: 2024-03-16T15:37:23Z

lastSyncStatus

string | null · enum

Status of the last reconciliation.

Enum values:

PENDING

RUNNING

COMPLETED

FAILED

Example: COMPLETED

object

The reconcile run kicked off by creating or editing the filter, to poll; null otherwise.

POST/api/v1/operator-lists

curl https://partner-api.monta.com/api/v1/operator-lists \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "VIP customers",
  "listType": "user",
  "description": "Customers eligible for discounted charging",
  "source": "FILTER",
  "syncMode": "AUTO",
  "filterDefinition": {
    "key": {}
  }
}'

Example Request Body

{
  "name": "VIP customers",
  "listType": "user",
  "description": "Customers eligible for discounted charging",
  "source": "FILTER",
  "syncMode": "AUTO",
  "filterDefinition": {
    "key": {}
  }
}

json

Example Responses

{
  "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",
  "filterDefinition": {
    "key": {}
  },
  "lastSyncedAt": "2024-03-16T15:37:23Z",
  "lastSyncStatus": "COMPLETED",
  "pendingSyncRun": {
    "id": 1,
    "listId": 42,
    "status": "COMPLETED",
    "trigger": "MANUAL",
    "matchedCount": 120,
    "addedCount": 5,
    "removedCount": 2,
    "proposedCount": 0,
    "excludedSkippedCount": 0,
    "errorMessage": "Search is unavailable; please retry.",
    "startedAt": "startedAt",
    "finishedAt": "finishedAt",
    "createdAt": "createdAt",
    "updatedAt": "updatedAt",
    "entityIdsByOutcome": {
      "matched": [
        1,
        2,
        3
      ],
      "added": [
        3
      ]
    }
  }
}

json

application/json

Preview how many charge points a filter matches

POST

https://partner-api.monta.com

/api/v1/operator-lists/filter-match-count

Counts how many charge points a filter definition matches right now, without saving it — for previewing a FILTER list before creating it. Required scope: operator-lists:read
Organization authorization: supported

Preview how many charge points a filter matches › Request Body

FilterMatchCountRequest

object · required

The filter definition to preview, in the same shape a FILTER list stores it.

Preview how many charge points a filter matches › Responses

The number of matching charge points

FilterMatchCount

count

integer · int32 · required

How many charge points the filter definition matches right now.

Example: 120

Retrieve an operator list

GET

https://partner-api.monta.com

/api/v1/operator-lists/{listId}

Required scope: operator-lists:read
Organization authorization: supported

Retrieve an operator list › path Parameters

listId

integer · int64 · required

Retrieve an operator list › Responses

Operator list with the provided id

OperatorList

id

integer · int64 · required

Id of the operator list.

Example: 1

operatorId

integer · int64 · required

Id of the operator that owns this list.

Example: 42

name

string · required

Name of the operator list.

Example: VIP customers

source

string · required

Origin of the list. partner for lists created via the Monta API.

Example: partner

itemCount

integer · int32 · required

Total number of items in the list.

Example: 12

object · required

Per-entity-type breakdown of the item count, keyed by entity type.

Example: {"user":8,"team":4}

description

string | null

Free-text description of the operator list.

Example: Customers eligible for discounted charging

listType

string | null · enum

The single entity type a homogeneous list is restricted to. null for mixed lists that can hold multiple entity types.

Enum values:

user

team

charge_point

charge_points_public

site

charge_key

vehicle

Example: user

createdByUserId

integer | null · int64

Id of the user who created the list, when known.

Example: 20

createdAt

string | null

When the list was created (ISO-8601).

Example: 2024-03-16T15:37:23Z

updatedAt

string | null

When the list was last updated (ISO-8601).

Example: 2024-03-16T15:37:23Z

syncMode

string | null · enum

Reconciliation mode of a FILTER list; null for a manually-curated list.

Enum values:

MANUAL

AUTO

Example: AUTO

object | null

The saved filter a FILTER-source list resolves its membership from; null for a manual list.

lastSyncedAt

string | null

When the list was last reconciled (ISO-8601); null if it never has been.

Example: 2024-03-16T15:37:23Z

lastSyncStatus

string | null · enum

Status of the last reconciliation.

Enum values:

PENDING

RUNNING

COMPLETED

FAILED

Example: COMPLETED

object

The reconcile run kicked off by creating or editing the filter, to poll; null otherwise.

GET/api/v1/operator-lists/{listId}

curl https://partner-api.monta.com/api/v1/operator-lists/:listId \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "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",
  "filterDefinition": {
    "key": {}
  },
  "lastSyncedAt": "2024-03-16T15:37:23Z",
  "lastSyncStatus": "COMPLETED",
  "pendingSyncRun": {
    "id": 1,
    "listId": 42,
    "status": "COMPLETED",
    "trigger": "MANUAL",
    "matchedCount": 120,
    "addedCount": 5,
    "removedCount": 2,
    "proposedCount": 0,
    "excludedSkippedCount": 0,
    "errorMessage": "Search is unavailable; please retry.",
    "startedAt": "startedAt",
    "finishedAt": "finishedAt",
    "createdAt": "createdAt",
    "updatedAt": "updatedAt",
    "entityIdsByOutcome": {
      "matched": [
        1,
        2,
        3
      ],
      "added": [
        3
      ]
    }
  }
}

json

application/json

Update an operator list

PATCH

https://partner-api.monta.com

/api/v1/operator-lists/{listId}

Updates the name and/or description of an operator list. Required scope: operator-lists:write
Organization authorization: supported

Update an operator list › path Parameters

listId

integer · int64 · required

Update an operator list › Request Body

UpdateOperatorList

name

string · minLength: 1 · maxLength: 255 · required

New name for the operator list.

Example: VIP customers

description

string | null · maxLength: 65535

New description for the operator list.

Example: Customers eligible for discounted charging

syncMode

string · enum

New reconciliation mode for a FILTER list. Only AUTO is supported. Ignored for a manual list.

Enum values:

MANUAL

AUTO

Example: AUTO

object | null

New filter definition for a FILTER list (charge-point lists only). A list's source is immutable, so this may only be set on a list that is already FILTER-source.

Update an operator list › Responses

Operator list successfully updated

OperatorList

id

integer · int64 · required

Id of the operator list.

Example: 1

operatorId

integer · int64 · required

Id of the operator that owns this list.

Example: 42

name

string · required

Name of the operator list.

Example: VIP customers

source

string · required

Origin of the list. partner for lists created via the Monta API.

Example: partner

itemCount

integer · int32 · required

Total number of items in the list.

Example: 12

object · required

Per-entity-type breakdown of the item count, keyed by entity type.

Example: {"user":8,"team":4}

description

string | null

Free-text description of the operator list.

Example: Customers eligible for discounted charging

listType

string | null · enum

The single entity type a homogeneous list is restricted to. null for mixed lists that can hold multiple entity types.

Enum values:

user

team

charge_point

charge_points_public

site

charge_key

vehicle

Example: user

createdByUserId

integer | null · int64

Id of the user who created the list, when known.

Example: 20

createdAt

string | null

When the list was created (ISO-8601).

Example: 2024-03-16T15:37:23Z

updatedAt

string | null

When the list was last updated (ISO-8601).

Example: 2024-03-16T15:37:23Z

syncMode

string | null · enum

Reconciliation mode of a FILTER list; null for a manually-curated list.

Enum values:

MANUAL

AUTO

Example: AUTO

object | null

The saved filter a FILTER-source list resolves its membership from; null for a manual list.

lastSyncedAt

string | null

When the list was last reconciled (ISO-8601); null if it never has been.

Example: 2024-03-16T15:37:23Z

lastSyncStatus

string | null · enum

Status of the last reconciliation.

Enum values:

PENDING

RUNNING

COMPLETED

FAILED

Example: COMPLETED

object

The reconcile run kicked off by creating or editing the filter, to poll; null otherwise.

PATCH/api/v1/operator-lists/{listId}

curl https://partner-api.monta.com/api/v1/operator-lists/:listId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "VIP customers",
  "description": "Customers eligible for discounted charging",
  "syncMode": "AUTO",
  "filterDefinition": {
    "key": {}
  }
}'

Example Request Body

{
  "name": "VIP customers",
  "description": "Customers eligible for discounted charging",
  "syncMode": "AUTO",
  "filterDefinition": {
    "key": {}
  }
}

json

Example Responses

{
  "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",
  "filterDefinition": {
    "key": {}
  },
  "lastSyncedAt": "2024-03-16T15:37:23Z",
  "lastSyncStatus": "COMPLETED",
  "pendingSyncRun": {
    "id": 1,
    "listId": 42,
    "status": "COMPLETED",
    "trigger": "MANUAL",
    "matchedCount": 120,
    "addedCount": 5,
    "removedCount": 2,
    "proposedCount": 0,
    "excludedSkippedCount": 0,
    "errorMessage": "Search is unavailable; please retry.",
    "startedAt": "startedAt",
    "finishedAt": "finishedAt",
    "createdAt": "createdAt",
    "updatedAt": "updatedAt",
    "entityIdsByOutcome": {
      "matched": [
        1,
        2,
        3
      ],
      "added": [
        3
      ]
    }
  }
}

json

application/json

Delete an operator list

DELETE

https://partner-api.monta.com

/api/v1/operator-lists/{listId}

Required scope: operator-lists:delete
Organization authorization: supported

Delete an operator list › path Parameters

listId

integer · int64 · required

Delete an operator list › Responses

Operator list successfully deleted

No data returned

Retrieve the items of an operator list

GET

https://partner-api.monta.com

/api/v1/operator-lists/{listId}/items

Retrieves a paginated list of items of a single entity type within an operator list. Required scope: operator-lists:read
Organization authorization: supported

Retrieve the items of an operator list › path Parameters

listId

integer · int64 · required

Retrieve the items of an operator list › query Parameters

entity_type

string · enum · required

The entity type of the items to retrieve.

Enum values:

user

team

charge_point

charge_points_public

site

charge_key

vehicle

search

string · maxLength: 255

Free-text search filter by item label. Max 255 characters.

page

integer · int32

Page number to retrieve (starts with 0)

Default: 0

perPage

integer · int32

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

Default: 10

Retrieve the items of an operator list › Responses

Paginated items of the operator list

OffsetBasedResponse_36

OperatorListItem[] · required

MontaPage.Meta · required

Add or remove items in an operator list

POST

https://partner-api.monta.com

/api/v1/operator-lists/{listId}/items

Adds or removes items in an operator list in a single request. Returns the updated operator list. Required scope: operator-lists:write
Organization authorization: supported

Add or remove items in an operator list › path Parameters

listId

integer · int64 · required

Add or remove items in an operator list › Request Body

UpdateOperatorListItems

action

string · enum · required

Whether to add the provided items to the list or remove them from it.

Enum values:

add

remove

Example: add

OperatorListItemRef[] · minItems: 1 · maxItems: 500 · required

The items to add or remove. All entity ids must belong to your operator's scope.

Add or remove items in an operator list › Responses

Operator list items successfully updated

OperatorList

id

integer · int64 · required

Id of the operator list.

Example: 1

operatorId

integer · int64 · required

Id of the operator that owns this list.

Example: 42

name

string · required

Name of the operator list.

Example: VIP customers

source

string · required

Origin of the list. partner for lists created via the Monta API.

Example: partner

itemCount

integer · int32 · required

Total number of items in the list.

Example: 12

object · required

Per-entity-type breakdown of the item count, keyed by entity type.

Example: {"user":8,"team":4}

description

string | null

Free-text description of the operator list.

Example: Customers eligible for discounted charging

listType

string | null · enum

The single entity type a homogeneous list is restricted to. null for mixed lists that can hold multiple entity types.

Enum values:

user

team

charge_point

charge_points_public

site

charge_key

vehicle

Example: user

createdByUserId

integer | null · int64

Id of the user who created the list, when known.

Example: 20

createdAt

string | null

When the list was created (ISO-8601).

Example: 2024-03-16T15:37:23Z

updatedAt

string | null

When the list was last updated (ISO-8601).

Example: 2024-03-16T15:37:23Z

syncMode

string | null · enum

Reconciliation mode of a FILTER list; null for a manually-curated list.

Enum values:

MANUAL

AUTO

Example: AUTO

object | null

The saved filter a FILTER-source list resolves its membership from; null for a manual list.

lastSyncedAt

string | null

When the list was last reconciled (ISO-8601); null if it never has been.

Example: 2024-03-16T15:37:23Z

lastSyncStatus

string | null · enum

Status of the last reconciliation.

Enum values:

PENDING

RUNNING

COMPLETED

FAILED

Example: COMPLETED

object

The reconcile run kicked off by creating or editing the filter, to poll; null otherwise.

POST/api/v1/operator-lists/{listId}/items

curl https://partner-api.monta.com/api/v1/operator-lists/:listId/items \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "action": "add",
  "items": [
    {
      "entityType": "user",
      "entityId": 20
    }
  ]
}'

Example Request Body

{
  "action": "add",
  "items": [
    {
      "entityType": "user",
      "entityId": 20
    }
  ]
}

json

Example Responses

{
  "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",
  "filterDefinition": {
    "key": {}
  },
  "lastSyncedAt": "2024-03-16T15:37:23Z",
  "lastSyncStatus": "COMPLETED",
  "pendingSyncRun": {
    "id": 1,
    "listId": 42,
    "status": "COMPLETED",
    "trigger": "MANUAL",
    "matchedCount": 120,
    "addedCount": 5,
    "removedCount": 2,
    "proposedCount": 0,
    "excludedSkippedCount": 0,
    "errorMessage": "Search is unavailable; please retry.",
    "startedAt": "startedAt",
    "finishedAt": "finishedAt",
    "createdAt": "createdAt",
    "updatedAt": "updatedAt",
    "entityIdsByOutcome": {
      "matched": [
        1,
        2,
        3
      ],
      "added": [
        3
      ]
    }
  }
}

json

application/json

Trigger a sync of a filter list

POST

https://partner-api.monta.com

/api/v1/operator-lists/{listId}/sync

Queues a reconcile of a FILTER-source list against its filter definition and returns the pending run to poll. Required scope: operator-lists:write
Organization authorization: supported

Trigger a sync of a filter list › path Parameters

listId

integer · int64 · required

Trigger a sync of a filter list › Responses

Sync queued; the pending run is returned

OperatorListSyncRun

id

integer · int64 · required

Id of the sync run.

Example: 1

listId

integer · int64 · required

Id of the list this run reconciled.

Example: 42

status

string · enum · required

Status of the run.

Enum values:

PENDING

RUNNING

COMPLETED

FAILED

Example: COMPLETED

trigger

string · enum · required

What triggered the run.

Enum values:

MANUAL

AUTO

CREATED

UPDATED

Example: MANUAL

matchedCount

integer | null · int32

How many entities the filter matched. Null until the run finishes.

Example: 120

addedCount

integer | null · int32

How many members were added. Null until the run finishes.

Example: 5

removedCount

integer | null · int32

How many members were removed. Null until the run finishes.

Example: 2

proposedCount

integer | null · int32

How many changes were proposed. Null until the run finishes.

Example: 0

excludedSkippedCount

integer | null · int32

How many candidates were skipped because they are excluded. Null until the run finishes.

Example: 0

errorMessage

string | null

Error message when the run failed.

Example: Search is unavailable; please retry.

startedAt

string | null

When the run started (ISO-8601).

finishedAt

string | null

When the run finished (ISO-8601).

createdAt

string | null

When the run was created (ISO-8601).

updatedAt

string | null

When the run was last updated (ISO-8601).

object | null

The charge-point ids behind each outcome tally, keyed by outcome. Only returned by the single-run endpoint.

Example: {"matched":[1,2,3],"added":[3]}

Retrieve the sync runs of a filter list

GET

https://partner-api.monta.com

/api/v1/operator-lists/{listId}/sync-runs

Retrieves a paginated list of a filter list's reconcile runs, newest first. Required scope: operator-lists:read
Organization authorization: supported

Retrieve the sync runs of a filter list › path Parameters

listId

integer · int64 · required

Retrieve the sync runs of a filter list › query Parameters

page

integer · int32

Page number to retrieve (starts with 0)

Default: 0

perPage

integer · int32

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

Default: 10

Retrieve the sync runs of a filter list › Responses

Paginated sync runs of the operator list

OffsetBasedResponse_37

OperatorListSyncRun[] · required

MontaPage.Meta · required

GET/api/v1/operator-lists/{listId}/sync-runs

curl https://partner-api.monta.com/api/v1/operator-lists/:listId/sync-runs \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "id": 1,
      "listId": 42,
      "status": "COMPLETED",
      "trigger": "MANUAL",
      "matchedCount": 120,
      "addedCount": 5,
      "removedCount": 2,
      "proposedCount": 0,
      "excludedSkippedCount": 0,
      "errorMessage": "Search is unavailable; please retry.",
      "startedAt": "startedAt",
      "finishedAt": "finishedAt",
      "createdAt": "createdAt",
      "updatedAt": "updatedAt",
      "entityIdsByOutcome": {
        "matched": [
          1,
          2,
          3
        ],
        "added": [
          3
        ]
      }
    }
  ],
  "meta": {
    "itemCount": 0,
    "currentPage": 0,
    "perPage": 0,
    "totalPageCount": 0,
    "totalItemCount": 0
  }
}

json

application/json

Retrieve a single sync run

GET

https://partner-api.monta.com

/api/v1/operator-lists/{listId}/sync-runs/{runId}

Retrieves a single sync run, including the charge-point ids behind each outcome. Required scope: operator-lists:read
Organization authorization: supported

Retrieve a single sync run › path Parameters

listId

integer · int64 · required

runId

integer · int64 · required

Retrieve a single sync run › Responses

The requested sync run

OperatorListSyncRun

id

integer · int64 · required

Id of the sync run.

Example: 1

listId

integer · int64 · required

Id of the list this run reconciled.

Example: 42

status

string · enum · required

Status of the run.

Enum values:

PENDING

RUNNING

COMPLETED

FAILED

Example: COMPLETED

trigger

string · enum · required

What triggered the run.

Enum values:

MANUAL

AUTO

CREATED

UPDATED

Example: MANUAL

matchedCount

integer | null · int32

How many entities the filter matched. Null until the run finishes.

Example: 120

addedCount

integer | null · int32

How many members were added. Null until the run finishes.

Example: 5

removedCount

integer | null · int32

How many members were removed. Null until the run finishes.

Example: 2

proposedCount

integer | null · int32

How many changes were proposed. Null until the run finishes.

Example: 0

excludedSkippedCount

integer | null · int32

How many candidates were skipped because they are excluded. Null until the run finishes.

Example: 0

errorMessage

string | null

Error message when the run failed.

Example: Search is unavailable; please retry.

startedAt

string | null

When the run started (ISO-8601).

finishedAt

string | null

When the run finished (ISO-8601).

createdAt

string | null

When the run was created (ISO-8601).

updatedAt

string | null

When the run was last updated (ISO-8601).

object | null

The charge-point ids behind each outcome tally, keyed by outcome. Only returned by the single-run endpoint.

Example: {"matched":[1,2,3],"added":[3]}

Onboarding Profiles Operators