---
title: "Start a SCIM directory sync"
method: POST
path: "/scim/sync-jobs"
tags: ["SCIM"]
---

# Start a SCIM directory sync

`POST /scim/sync-jobs`

Start a SCIM directory sync. [Management key](/docs/guides/overview/auth/management-api-keys) required.

## Response `202`

SCIM directory sync job queued

- CreateScimSyncJobResponse
  - `data` ScimSyncJob, required
    - `created_at` string, required — Time when the sync job was created.
    - `deleted_groups` integer, nullable, required — Number of groups deleted, when the job completed successfully.
    - `error_message` string, nullable, required — Stable error message when the job failed.
    - `finished_at` string, nullable, required — Time when synchronization finished.
    - `id` string, uuid, required — Unique identifier for the sync job.
    - `started_at` string, nullable, required — Time when synchronization started.
    - `status` 'queued' | 'running' | 'succeeded' | 'failed', required — Current status of the sync job: queued, running, succeeded, or failed.
    - `synced_groups` integer, nullable, required — Number of groups synchronized, when the job completed successfully.

## Other responses

- `401` — Unauthorized - Authentication required or invalid credentials
- `404` — Not Found - Resource does not exist
- `500` — Internal Server Error - Unexpected server error

## Changes

- **2026-09-04** `46a1bda5f693` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/openrouterteam/apis/openrouter-api/changes/scim/sync-jobs/post.md)

---

[API](https://skmtc.dev/openrouterteam/apis/openrouter-api.md) · [All operations](https://skmtc.dev/openrouterteam/apis/openrouter-api/llms.txt) · [OpenAPI document](https://skmtc.dev/openrouterteam/apis/openrouter-api/revisions/1e05e5f6495c?raw)