---
title: "Trigger a sync of a filter list"
method: POST
path: "/api/v1/operator-lists/{listId}/sync"
tags: ["Operator Lists"]
---

# Trigger a sync of a filter list

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

## Request

- Base URL: `https://partner-api.monta.com`
- URL: `https://partner-api.monta.com/api/v1/operator-lists/{listId}/sync`
- Auth: HTTP bearer

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

## Path parameters

- `listId` integer, required

## Response `202`

Sync queued; the pending run is returned

- OperatorListSyncRun
  - `id` integer, required: Id of the sync run.
  - `listId` integer, required: Id of the list this run reconciled.
  - `status` 'PENDING' | 'RUNNING' | 'COMPLETED' | 'FAILED', required: Status of the run.
  - `trigger` 'MANUAL' | 'AUTO' | 'CREATED' | 'UPDATED', required: What triggered the run.
  - `matchedCount` integer, nullable: How many entities the filter matched. Null until the run finishes.
  - `addedCount` integer, nullable: How many members were added. Null until the run finishes.
  - `removedCount` integer, nullable: How many members were removed. Null until the run finishes.
  - `proposedCount` integer, nullable: How many changes were proposed. Null until the run finishes.
  - `excludedSkippedCount` integer, nullable: How many candidates were skipped because they are excluded. Null until the run finishes.
  - `errorMessage` string, nullable: Error message when the run failed.
  - `startedAt` string, nullable: When the run started (ISO-8601).
  - `finishedAt` string, nullable: When the run finished (ISO-8601).
  - `createdAt` string, nullable: When the run was created (ISO-8601).
  - `updatedAt` string, nullable: When the run was last updated (ISO-8601).
  - `entityIdsByOutcome` object, nullable: The charge-point ids behind each outcome tally, keyed by outcome. Only returned by the single-run endpoint.

## Other responses

- `400`: The request is invalid
- `401`: Consumer with provided credentials was not found
- `403`: Operator doesn't have access to resource
- `404`: Operator list not found

## Changes

- **2026-11-03** `0ca400461c52`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/monta/apis/monta-partner-api/changes/api/v1/operator-lists/:listId/sync/post.md)

---

[API](https://skmtc.dev/monta/apis/monta-partner-api.md) - [All operations](https://skmtc.dev/monta/apis/monta-partner-api/llms.txt) - [OpenAPI document](https://skmtc.dev/monta/apis/monta-partner-api/revisions/0ca400461c52?raw)