Set the employee sync provider | Comp AI API

Set the employee sync provider in Comp AI. Connect vendor systems, configure OAuth apps, run compliance checks, sync employees, manage variables.

POST /v1/integrations/sync/employee-sync-provider

Set the employee sync provider

cURL

curl --request POST \
  --url https://api.trycomp.ai/v1/integrations/sync/employee-sync-provider \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "organizationId": "<string>",
  "provider": "google-workspace"
}
'

Authorizations

apikeyoauth2

X-API-Key · string · header · required

API key for authentication

Body

application/json

organizationId · string

Auto-resolved from your API key / session. You can omit this; it is ignored by the server.

provider · object

Provider slug to use for employee sync (must have the "sync" capability in its manifest — call list-providers to see options). Pass null or omit the field to disable employee sync for this org.

Example:

"google-workspace"

Response

201 - undefined