---
title: "Get sync job options"
method: GET
path: "/api/v1/get/syncjob_options"
tags: ["Sync jobs"]
---

# Get sync job options

`GET /api/v1/get/syncjob_options`

## Request

- Base URL: `/` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/api/v1/get/syncjob_options`
- Auth: API key in header `X-API-Key`

Returns the allowlist of imapsync options accepted in a sync job's `custom_params` as option => rule: `true` = requires a non-empty value, `false` = flag without value, string = regular expression the whole value must match.

## Headers

- `X-API-Key` string

## Response `200`

OK

## Other responses

- `401`: Unauthorized

## Changes

- **2026-10-22** `cf82ac1f801a`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/mailcow/apis/mailcow-api/changes/api/v1/get/syncjob_options/get.md)

---

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