Get CRM sync job

Read the status and result counts of one CRM sync job.

GEThttps://api.tried.com.au/get-crm-sync-job/{id}

Returns one sync job started with Run CRM sync job. Poll it until status is complete or failed.

Request#

Path parameter	Type	Required	Description
`id`	string	Yes	The `job_id`, for example `crm_sync_5b2e8f1a7c4d9036e1b5a8f2`.

Example request#

curl https://api.tried.com.au/get-crm-sync-job/crm_sync_5b2e8f1a7c4d9036e1b5a8f2 \
  -H "Authorization: Bearer $TRIED_API_KEY"

const res = await fetch(
  "https://api.tried.com.au/get-crm-sync-job/crm_sync_5b2e8f1a7c4d9036e1b5a8f2",
  { headers: { Authorization: `Bearer ${process.env.TRIED_API_KEY}` } },
);
const job = await res.json();

import os, requests

res = requests.get(
    "https://api.tried.com.au/get-crm-sync-job/crm_sync_5b2e8f1a7c4d9036e1b5a8f2",
    headers={"Authorization": f"Bearer {os.environ['TRIED_API_KEY']}"},
)
job = res.json()

Response#

200 OK

{
  "job_id": "crm_sync_5b2e8f1a7c4d9036e1b5a8f2",
  "provider": "hubspot",
  "kind": "full",
  "status": "complete",
  "stats": {
    "contacts": 118,
    "notes": 96,
    "failed": 2,
    "errors": [
      "+61412345678: POST /crm/v3/objects/contacts returned 400: {...}",
      "+14155550123: POST /crm/v3/objects/contacts returned 400: {...}"
    ]
  },
  "error": null,
  "mock": false,
  "created_timestamp": 1792397000000,
  "completed_timestamp": 1792397042000
}

Field	Type	Description
`kind`	string	`full` or `contact`.
`status`	string	`pending`, `running`, `complete` or `failed`.
`stats.contacts`	integer	Contacts pushed to the CRM.
`stats.notes`	integer	Call notes added.
`stats.failed`	integer	Contacts that failed.
`stats.errors`	string[]	Up to 50 messages, each prefixed with the contact's phone number.
`error`	string or null	Set when the whole job failed, for example when the connection was deleted while it ran.
`completed_timestamp`	integer or null	When the job finished.

Before the job finishes, stats holds only the requested contact_ids.

Errors#

Status	When
`401`	Missing or invalid API key.
`403`	The key's IP allowlist or scopes reject the request. This route needs the `admin` scope.
`404`	`CRM sync job <id> not found` in this workspace.
`429`	Rate limit exceeded. See Rate limits.

See Errors for the body format.

Retell compatibility#

Retell uses GET /get-sync-job-status with no ID and returns the current job status. Tried reads a specific job by ID at GET /get-crm-sync-job/{id}.