Census CLI

The Paradime SDK provides CLI commands to interact with Census, allowing you to trigger syncs and list available syncs with their status.

🔑 API Access RequiredYou will need a Census API token to use these commands. You can find this in your Census account settings.You can set your token as the CENSUS_API_TOKEN environment variable so you don’t have to pass --api-token on every command.

Trigger Census Syncs

Trigger syncs for Census.

CLI Command

paradime run census-sync

Options

Flag	Type	Description
`--api-token`	Required, TEXT	Your Census API token. You can find this in your Census account settings. `[env: CENSUS_API_TOKEN]`
`--sync-ids`	Required, TEXT (comma-separated)	Comma-separated sync ID(s) to trigger
`--force-full-sync`	Optional, Flag	Force a full sync instead of incremental. Default: `False`.
`--wait` / `--no-wait`	Optional, Flag	Wait for syncs to complete before returning (default: True) `[env: CENSUS_SYNC_WAIT]`
`--timeout`	Optional, INTEGER	Maximum time to wait in minutes. Default: `1440`. `[env: CENSUS_SYNC_TIMEOUT]`
`--json`	Optional, Flag	Output results as JSON. Default: `False`.
`--help`	Optional, Flag	Show the help message and exit.

Examples

# Using the CENSUS_API_TOKEN environment variable (recommended)
paradime run census-sync --sync-ids "12345,67890"

# Force a full sync and wait up to 60 minutes
paradime run census-sync \
  --sync-ids "12345" \
  --force-full-sync \
  --timeout 60

# With an explicit API token
paradime run census-sync \
  --api-token "your_census_api_token" \
  --sync-ids "12345"

List Census Syncs

List all available Census syncs with their status.

CLI Command

paradime run census-list-syncs

Options

Flag	Type	Description
`--api-token`	Required, TEXT	Your Census API token. You can find this in your Census account settings. `[env: CENSUS_API_TOKEN]`
`--json`	Optional, Flag	Output results as JSON. Default: `False`.
`--help`	Optional, Flag	Show the help message and exit.

Examples

# List all Census syncs
paradime run census-list-syncs

# Output as JSON
paradime run census-list-syncs --json

Environment Variable Reference

Environment Variable	Description
`CENSUS_API_TOKEN`	Your Census API token
`CENSUS_SYNC_WAIT`	Whether to wait for syncs to complete (`census-sync`)
`CENSUS_SYNC_TIMEOUT`	Maximum time to wait in minutes (`census-sync`)

API Keys & Access

GraphQL API

Python SDK

Paradime CLI

Webhooks

Virtual Environments

Trigger Census Syncs

CLI Command

Examples

List Census Syncs

CLI Command

Examples

Environment Variable Reference

​Trigger Census Syncs

​CLI Command

​Examples

​List Census Syncs

​CLI Command

​Examples

​Environment Variable Reference

Trigger Census Syncs

CLI Command

Examples

List Census Syncs

CLI Command

Examples

Environment Variable Reference