/v1/workspaces/{workspace_id}/integrations/github/sync/{sync_id}AuthPoll a sync run's status.
Path parameters
workspace_id*string · uuidId of the workspace.
sync_id*stringId of the sync.
Response · 200
status*objectWhere the sync is: `running`, then `completed` or `failed`.
started_at*string · date-timeWhen the sync started.
ended_at*string · date-timeWhen the sync finished; null while running.
summary*objectCounts of what the sync changed; null while running.
error*stringWhy the sync failed; null unless `failed`.
Example
Request
GET https://api.mail.productcraft.co/v1/workspaces/{workspace_id}/integrations/github/sync/{sync_id}
Authorization: Bearer YOUR_TOKENimport { Mail } from "@productcraft/mail";
// Reads PRODUCTCRAFT_API_KEY from the environment
const mail = new Mail();
const syncStatus = await mail.integrations.github.sync.retrieve("3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b");mail.integrations.github.sync.retrieve(syncId, options?): Mail.SyncStatus
Response
{
"status": {},
"started_at": "2026-01-01T00:00:00.000Z",
"ended_at": "2026-01-01T00:00:00.000Z",
"summary": {},
"error": "string"
}