outboundsync me
ReadAPI keyShow the account, API key, and connections for this key.
outboundsync meAPI route: GET /api/v1/me
Install the OutboundSync CLI from npm, authenticate with an API key, and run API v1 commands for syncs, sources, block lists, and webhooks.
When to use this guide: You want to check readiness, inspect syncs, retry errors, or manage webhooks from a terminal, a shell script, or a CI job, without writing REST calls by hand.
outboundsync is the command-line interface for the OutboundSync API v1. It covers the same surface as the OutboundSync MCP: account readiness, sources, syncs, destinations, block lists, webhooks, events, and prior outreach. Each command calls one API route with your API key and prints JSON, so its output pipes straight into jq, a log, or an agent.
The CLI is in Beta. It’s open source (outboundsync/outboundsync-cli) and published to npm as outboundsync. The command reference below is generated from the CLI’s own command registry, so it always matches the published package.
The CLI needs Node.js 20 or newer and has no runtime dependencies.
npm i -g outboundsyncoutboundsync --helpOr run it without installing:
npx outboundsync --helpoutboundsync with no arguments prints every command. outboundsync <group> lists one group, and outboundsync <command> --help shows that command’s flags.
The CLI uses the same API keys as REST and MCP. Create a key under Platform access → API keys (it starts with osapi_), then export it:
export OUTBOUNDSYNC_API_KEY=osapi_your_key_hereoutboundsync meoutboundsync me shows the key’s scopes and whether it’s account-wide or scoped to one CRM connection. There’s no login command, and the CLI never stores or prints the key.
--token <key> overrides the variable for one command, but a flag value shows up in shell history and the process list. Prefer the variable.write scope; ask OutboundSync support for one. See Scopes.webhooks commands need an account-wide key, and webhooks and events commands need Sync Monitoring webhooks on your plan.https://app.outboundsync.com/api/v1. OUTBOUNDSYNC_API_BASE_URL or --base-url overrides it; the CLI accepts only https and doesn’t follow redirects, so the key is only ever sent to that base URL.--yesEvery command that changes something exits with code 1, without calling the API, unless you pass --yes, and says what it would have done. Confirm the target first, then add the flag:
outboundsync syncs get 1001outboundsync syncs retry 1001 --yesoutboundsync syncs retry re-queues one failed HubSpot or Salesforce sync. outboundsync sources retry-syncs re-queues every recorded error from the last 30 days for one source, once per source per 24 hours, so retry one sync first to check the fix.outboundsync destinations replay and outboundsync webhooks replay queue a delivery to be sent to its URL again; the API answers before the re-send happens.outboundsync blocklists pause stops fetching and pushing a list. outboundsync blocklists resync turns it back on and queues a full reload from the CRM.outboundsync webhooks delete is a soft delete the API can’t undo. outboundsync webhooks rotate-secret stops the old secret verifying at once.outboundsync webhooks create and outboundsync webhooks rotate-secret print the oswhsec_… signing secret once. Store it then: a later read doesn’t return it.
Range commands take --from and --to as full ISO-8601 timestamps with a timezone offset (2026-08-01T00:00:00Z), or --since 24h|7d|30d, which ends at now. A range can span at most 31 days, the same as the API.
List commands accept --cursor and --limit. --all follows nextCursor until the API reports no more pages, up to 200 pages (--max-pages raises the cap); with --json it prints one JSON object per line.
outboundsync account statusoutboundsync syncs list --since 24h --status error --connection-id 7outboundsync destinations deliveries 3 --since 7d --status error --all --jsonoutboundsync contacts outreach --file contacts.csv --json > outreach.jsonlSuccess prints pretty JSON on stdout; --json prints compact JSON with no summary line. Errors go to stderr, and the exit code says what happened, so scripts can branch on it:
| Code | Meaning |
|---|---|
0 |
Success |
1 |
Usage or validation error, including a missing --yes |
2 |
Unauthorized (401): the key is missing, invalid, or revoked |
3 |
Forbidden (403): no write scope, a connection-scoped key on a webhook command, or a plan feature that isn’t on |
4 |
Rate limited (429) |
5 |
Server error (5xx), timeout, network error, or a response that wasn’t JSON |
6 |
Any other HTTP status, including 400, 404, and 409 |
The CLI retries a 429 once when Retry-After fits in 30 seconds, and a failed read once after a 5xx other than 504. It never retries a write. All keys on an account share 120 requests per 60 seconds, and outboundsync contacts outreach has its own 600 per 60 seconds. See Errors and rate limits.
| Surface | Best for |
|---|---|
| CLI (this page) | Terminals, shell scripts, cron and CI jobs, and agents that run shell commands |
| MCP | Coding agents calling OutboundSync tools directly from Cursor, Claude Code, or Codex |
| API | Your own code, low-code HTTP modules, and anything that speaks REST |
| Agent Skills | Guided workflows such as launch preflight and sync monitoring |
All four use the same API keys and the same API v1 routes.
The CLI is built to be driven by coding agents and scripts, not just people at a terminal.
outboundsync me. It tells the agent which scopes the key has and whether it’s account-wide, so it knows up front which commands will be allowed.--json and branch on the exit code. Output is plain JSON on stdout, errors go to stderr, and the exit codes separate a bad key (2), a missing scope (3), rate limits (4), and server trouble (5).--yes. Run the command without it first: it exits 1 and says what it would change. Show that to the user, then re-run with --yes.npx outboundsync@<version> runs an exact release; npx outboundsync uses the latest.commands.json, the machine-readable version of the reference below (command, usage, flags, API route, and whether it writes). It’s also at commands.json on GitHub.Every command, grouped by what it works on. Each API route links to its section in the API v1 reference, which documents fields, responses, and errors.
38 commands: 27 read, 11 write. Generated from theCLI's command registry, so it matches the published package.
outboundsync meShow the account, API key, and connections for this key.
outboundsync meAPI route: GET /api/v1/me
outboundsync account metricsCount requests, syncs, and destination deliveries in a date range.
outboundsync account metrics (--from <iso> --to <iso> | --since 24h|7d|30d)API route: GET /api/v1/account/metrics
| Flag | Description |
|---|---|
--connection-id | Count one connection. |
--source-id | Count one source. Does not filter destination deliveries. |
--from | Range start, ISO-8601 with a timezone offset. |
--to | Range end, ISO-8601 with a timezone offset. |
--since | Relative range: 24h, 7d, or 30d. Sets --to to now. Values: 24h, 7d, 30d. |
outboundsync account statusShow whether this account is ready to sync, with blockers.
outboundsync account statusAPI route: GET /api/v1/account/status
outboundsync setupShow the setup wizard for this key.
outboundsync setupAPI route: GET /api/v1/setup
outboundsync connections listList CRM connections visible to this key.
outboundsync connections listAPI route: GET /api/v1/connections
outboundsync openapiPrint the OpenAPI document. No API key required.
outboundsync openapiAPI route: GET /api/v1/openapi.yaml
| Flag | Description |
|---|---|
--format | Document format. Default yaml. Values: yaml, json. |
outboundsync contacts outreachLook up whether a contact was outreached. Pass --email, --profile-url, or --file.
outboundsync contacts outreachAPI route: GET /api/v1/contacts/outreach
| Flag | Description |
|---|---|
--email | One email address. |
--profile-url | LinkedIn (/in/ or /pub/) or X profile URL. Repeat up to 5 times. |
--file | JSONL or CSV file of contacts. Use - to read stdin. |
outboundsync sources listList webhook sources and their config.
outboundsync sources listAPI route: GET /api/v1/sources
outboundsync sources requestsList webhook requests received by one source.
outboundsync sources requests <sourceId> (--from <iso> --to <iso> | --since 24h|7d|30d)API route: GET /api/v1/sources/{sourceId}/requests
| Flag | Description |
|---|---|
--from | Range start, ISO-8601 with a timezone offset. |
--to | Range end, ISO-8601 with a timezone offset. |
--since | Relative range: 24h, 7d, or 30d. Sets --to to now. Values: 24h, 7d, 30d. |
--cursor | Page cursor from a previous response. |
--limit | Page size. Default 100, max 500. Omitted unless you pass it. |
--all | Follow nextCursor until the server reports no more pages. |
--max-pages | Stop after this many pages. Default 200. |
outboundsync sources retry-syncsBulk-retry failed HubSpot and Salesforce syncs for one source. Requires --yes and the write scope.
outboundsync sources retry-syncs <sourceId>API route: POST /api/v1/sources/{sourceId}/syncs/retry
| Flag | Description |
|---|---|
--yesrequired | Confirm this write. |
outboundsync sources syncsList CRM syncs for one source.
outboundsync sources syncs <sourceId> (--from <iso> --to <iso> | --since 24h|7d|30d)API route: GET /api/v1/sources/{sourceId}/syncs
| Flag | Description |
|---|---|
--status | Filter by sync status. Values: success, warning, error. |
--connection-id | Filter by connection. |
--from | Range start, ISO-8601 with a timezone offset. |
--to | Range end, ISO-8601 with a timezone offset. |
--since | Relative range: 24h, 7d, or 30d. Sets --to to now. Values: 24h, 7d, 30d. |
--cursor | Page cursor from a previous response. |
--limit | Page size. Default 100, max 500. Omitted unless you pass it. |
--all | Follow nextCursor until the server reports no more pages. |
--max-pages | Stop after this many pages. Default 200. |
outboundsync requests listList webhook requests in a date range.
outboundsync requests list (--from <iso> --to <iso> | --since 24h|7d|30d)API route: GET /api/v1/requests
| Flag | Description |
|---|---|
--source-id | Filter by source. |
--from | Range start, ISO-8601 with a timezone offset. |
--to | Range end, ISO-8601 with a timezone offset. |
--since | Relative range: 24h, 7d, or 30d. Sets --to to now. Values: 24h, 7d, 30d. |
--cursor | Page cursor from a previous response. |
--limit | Page size. Default 100, max 500. Omitted unless you pass it. |
--all | Follow nextCursor until the server reports no more pages. |
--max-pages | Stop after this many pages. Default 200. |
outboundsync requests metricsCount webhook requests in a date range.
outboundsync requests metrics (--from <iso> --to <iso> | --since 24h|7d|30d)API route: GET /api/v1/requests/metrics
| Flag | Description |
|---|---|
--source-id | Count one source. |
--from | Range start, ISO-8601 with a timezone offset. |
--to | Range end, ISO-8601 with a timezone offset. |
--since | Relative range: 24h, 7d, or 30d. Sets --to to now. Values: 24h, 7d, 30d. |
outboundsync syncs getShow one CRM sync, including its error.
outboundsync syncs get <id>API route: GET /api/v1/syncs/{id}
outboundsync syncs listList CRM syncs in a date range.
outboundsync syncs list (--from <iso> --to <iso> | --since 24h|7d|30d)API route: GET /api/v1/syncs
| Flag | Description |
|---|---|
--status | Filter by sync status. Values: success, warning, error. |
--source-id | Filter by source. |
--connection-id | Filter by connection. |
--from | Range start, ISO-8601 with a timezone offset. |
--to | Range end, ISO-8601 with a timezone offset. |
--since | Relative range: 24h, 7d, or 30d. Sets --to to now. Values: 24h, 7d, 30d. |
--cursor | Page cursor from a previous response. |
--limit | Page size. Default 100, max 500. Omitted unless you pass it. |
--all | Follow nextCursor until the server reports no more pages. |
--max-pages | Stop after this many pages. Default 200. |
outboundsync syncs metricsCount CRM syncs in a date range.
outboundsync syncs metrics (--from <iso> --to <iso> | --since 24h|7d|30d)API route: GET /api/v1/syncs/metrics
| Flag | Description |
|---|---|
--source-id | Count one source. |
--connection-id | Count one connection. |
--from | Range start, ISO-8601 with a timezone offset. |
--to | Range end, ISO-8601 with a timezone offset. |
--since | Relative range: 24h, 7d, or 30d. Sets --to to now. Values: 24h, 7d, 30d. |
outboundsync syncs retryRe-queue one failed HubSpot or Salesforce sync. Requires --yes and the write scope.
outboundsync syncs retry <id>API route: POST /api/v1/syncs/{id}/retry
| Flag | Description |
|---|---|
--yesrequired | Confirm this write. |
outboundsync destinations deliveriesList deliveries for one destination.
outboundsync destinations deliveries <id> (--from <iso> --to <iso> | --since 24h|7d|30d)API route: GET /api/v1/destinations/{id}/deliveries
| Flag | Description |
|---|---|
--status | Filter by delivery status. Values: success, error. |
--from | Range start, ISO-8601 with a timezone offset. |
--to | Range end, ISO-8601 with a timezone offset. |
--since | Relative range: 24h, 7d, or 30d. Sets --to to now. Values: 24h, 7d, 30d. |
--cursor | Page cursor from a previous response. |
--limit | Page size. Default 100, max 500. Omitted unless you pass it. |
--all | Follow nextCursor until the server reports no more pages. |
--max-pages | Stop after this many pages. Default 200. |
outboundsync destinations delivery-metricsCount deliveries for one destination.
outboundsync destinations delivery-metrics <id> (--from <iso> --to <iso> | --since 24h|7d|30d)API route: GET /api/v1/destinations/{id}/deliveries/metrics
| Flag | Description |
|---|---|
--from | Range start, ISO-8601 with a timezone offset. |
--to | Range end, ISO-8601 with a timezone offset. |
--since | Relative range: 24h, 7d, or 30d. Sets --to to now. Values: 24h, 7d, 30d. |
outboundsync destinations getShow one destination.
outboundsync destinations get <id>API route: GET /api/v1/destinations/{id}
outboundsync destinations listList outbound destinations.
outboundsync destinations listAPI route: GET /api/v1/destinations
outboundsync destinations replayReplay one destination delivery. Requires --yes and the write scope.
outboundsync destinations replay <id> <deliveryId>API route: POST /api/v1/destinations/{id}/deliveries/{deliveryId}/replay
| Flag | Description |
|---|---|
--yesrequired | Confirm this write. |
outboundsync destinations reply-relaysList reply-relay destinations.
outboundsync destinations reply-relaysAPI route: GET /api/v1/destinations/reply-relays
outboundsync deliveries listList destination deliveries in a date range.
outboundsync deliveries list (--from <iso> --to <iso> | --since 24h|7d|30d)API route: GET /api/v1/deliveries
| Flag | Description |
|---|---|
--status | Filter by delivery status. Values: success, error. |
--destination-id | Filter by destination. |
--from | Range start, ISO-8601 with a timezone offset. |
--to | Range end, ISO-8601 with a timezone offset. |
--since | Relative range: 24h, 7d, or 30d. Sets --to to now. Values: 24h, 7d, 30d. |
--cursor | Page cursor from a previous response. |
--limit | Page size. Default 100, max 500. Omitted unless you pass it. |
--all | Follow nextCursor until the server reports no more pages. |
--max-pages | Stop after this many pages. Default 200. |
outboundsync blocklists listList block lists.
outboundsync blocklists listAPI route: GET /api/v1/blocklists
| Flag | Description |
|---|---|
--connection-id | Filter by connection. |
outboundsync blocklists pausePause one block list. Requires --yes and the write scope.
outboundsync blocklists pause <id>API route: POST /api/v1/blocklists/{id}/pause
| Flag | Description |
|---|---|
--yesrequired | Confirm this write. |
outboundsync blocklists resyncReload one block list from the CRM. Requires --yes and the write scope.
outboundsync blocklists resync <id>API route: POST /api/v1/blocklists/{id}/resync
| Flag | Description |
|---|---|
--yesrequired | Confirm this write. |
outboundsync webhooks createCreate a platform webhook endpoint. The signing secret is printed once. Requires --yes, the write scope, and an account-scoped key.
outboundsync webhooks createAPI route: POST /api/v1/webhooks
| Flag | Description |
|---|---|
--urlrequired | https endpoint that will receive events. |
--description | Optional label, at most 500 characters. |
--event | Event type to enable. Repeat to set the list. Omit to enable every event. |
--yesrequired | Confirm this write. |
outboundsync webhooks deleteSoft-delete a platform webhook endpoint. Requires --yes, the write scope, and an account-scoped key.
outboundsync webhooks delete <id>API route: DELETE /api/v1/webhooks/{id}
| Flag | Description |
|---|---|
--yesrequired | Confirm this write. |
outboundsync webhooks deliveriesList delivery attempts for one platform webhook. Requires an account-scoped key.
outboundsync webhooks deliveries <id>API route: GET /api/v1/webhooks/{id}/deliveries
| Flag | Description |
|---|---|
--status | Filter by delivery status. Values: PENDING, SUCCEEDED, FAILED, DEAD. |
--cursor | Page cursor from a previous response. |
--limit | Page size. Default 25, max 100. Omitted unless you pass it. |
--all | Follow nextCursor until the server reports no more pages. |
--max-pages | Stop after this many pages. Default 200. |
outboundsync webhooks getShow one platform webhook endpoint. Requires an account-scoped key.
outboundsync webhooks get <id>API route: GET /api/v1/webhooks/{id}
outboundsync webhooks listList platform webhook endpoints. Requires an account-scoped key.
outboundsync webhooks listAPI route: GET /api/v1/webhooks
outboundsync webhooks replayReplay one platform webhook delivery. Requires --yes, the write scope, and an account-scoped key.
outboundsync webhooks replay <id> <deliveryId>API route: POST /api/v1/webhooks/{id}/deliveries/{deliveryId}/replay
| Flag | Description |
|---|---|
--yesrequired | Confirm this write. |
outboundsync webhooks rotate-secretRotate a webhook signing secret. The new secret is printed once. Requires --yes, the write scope, and an account-scoped key.
outboundsync webhooks rotate-secret <id>API route: POST /api/v1/webhooks/{id}/rotate-secret
| Flag | Description |
|---|---|
--yesrequired | Confirm this write. |
outboundsync webhooks testQueue a test.ping delivery to one platform webhook. Requires --yes, the write scope, and an account-scoped key.
outboundsync webhooks test <id>API route: POST /api/v1/webhooks/{id}/test
| Flag | Description |
|---|---|
--yesrequired | Confirm this write. |
outboundsync webhooks updateUpdate a platform webhook endpoint. Pass at least one field. Requires --yes, the write scope, and an account-scoped key.
outboundsync webhooks update <id>API route: PATCH /api/v1/webhooks/{id}
| Flag | Description |
|---|---|
--url | Replacement https endpoint. |
--description | Replacement label, at most 500 characters. |
--event | Replacement event type. Repeat to replace the list. |
--active | true to enable the endpoint, false to disable it. Values: true, false. |
--yesrequired | Confirm this write. |
outboundsync events getShow one platform event and its deliveries. Connection-scoped keys see their connection's events plus account-level events.
outboundsync events get <id>API route: GET /api/v1/events/{id}
outboundsync events listList platform events. Connection-scoped keys see their connection's events plus account-level events.
outboundsync events listAPI route: GET /api/v1/events
| Flag | Description |
|---|---|
--type | Event type. Repeat to include more than one. |
--delivered | true for events with at least one successful delivery, false for the rest. Values: true, false. |
--cursor | Page cursor from a previous response. |
--limit | Page size. Default 25, max 100. Omitted unless you pass it. |
--all | Follow nextCursor until the server reports no more pages. |
--max-pages | Stop after this many pages. Default 200. |