Get sync status

Get the current sync status for a directory. Admin role required.

GET /v1/admin/directory/{id}/sync-status

Get sync status

cURL

curl --request GET \
  --url http://co-mind-platform-host/v1/admin/directory/{id}/sync-status \
  --header 'Authorization: Bearer <token>'

200

{
  "lastSyncAt": "2023-11-07T05:31:56Z",
  "usersSync": 123,
  "errors": [
    "<string>"
  ]
}

Authorizations

Authorization · string · header · required

Bearer token authentication. Supports two token types:

• JWT Access Token — obtained via POST /v1/auth/login
• Personal Access Token (PAT) — created via POST /v1/api-tokens, format: cmnd_<tokenId>.<secret>

Path Parameters

id · string · required

The IDP config ID

Response

200

application/json

Sync status

status · enum<string>

Available options: idle, running, completed, failed

lastSyncAt · string<date-time>

usersSync · integer

errors · string[]