1. Partner API v2
  2. Resources
  3. Sync

Sync

Directory sync status for Microsoft 365 and Google Workspace.
1 endpointScope readSyncStatus
GET/v2/clients/{client_id}/sync

Get directory sync statusLink to this endpoint

RequiresreadscopeReturns SyncStatus

Which directory the client is connected to, when it last synced, and whether the last run failed.

Path parameters

client_idstringRequired

Client id (the client's INFIMA id).

curl "https://app.infimasecapis.com/v2/clients/3f2a9c1e-7b44-5d2e-9a1f-0c6d8e4b2a10/sync" \
  -H "X-API-Key: $INFIMA_API_KEY"
Response objectSyncStatus
client_idstring
configuredboolean
providerstringNullable
One ofmicrosoftgoogle
enabledboolean
last_run_atstring (date-time)Nullable

When the last successful sync finished. Null if no sync has succeeded yet; a failed run has no recorded time, so check last_run_status and last_error.

last_run_statusstringNullable
One ofsucceededfailed
last_errorstringNullable
groups_syncedinteger
users_syncedinteger
Coming in 2.x1 more Sync operation is specified for a later 2.x release.See the roadmap