Enterprise quickstart

You will create a workspace for one client, import a list of LinkedIn URLs for it, wait for the job, and read the paths. You need an organization key with the default scopes. Set it once:

export CLUSTR_ORG_KEY="clo_..."
export CLUSTR=https://api.clustr-ai.com

Create a workspace

curl -X POST $CLUSTR/api/org/v1/tenants \
  -H "Authorization: Bearer $CLUSTR_ORG_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Acme", "externalId": "client-1234" }'

The answer is 201. data.id is the workspace id. From now on you can name the workspace by that id or by client-1234. 409 means the externalId is taken.

Import LinkedIn URLs

Send the list as linkedin_urls, and name the workspace in X-Clustr-Tenant. The Idempotency-Key makes a retry safe.

curl -X POST $CLUSTR/api/public/network/import/connectors \
  -H "Authorization: Bearer $CLUSTR_ORG_KEY" \
  -H "X-Clustr-Tenant: client-1234" \
  -H "Idempotency-Key: client-1234-batch-001" \
  -H "Content-Type: application/json" \
  -d '{ "linkedin_urls": ["https://www.linkedin.com/in/jane-doe", "https://www.linkedin.com/in/john-smith"] }'

Each URL is a profile in /in/name form. The answer carries data.job_id, which you use in the next step, and data.stats.

400 means the list is longer than one job can take. Send it in several requests.
422 with code ORG_LIMIT_EXCEEDED means your contract limit is used up. See Usage and limits.

More on sizes and scheduling in Bulk jobs.

Wait for the job

Poll Get Job Status until status is COMPLETED.

curl $CLUSTR/api/public/jobs/$JOB_ID \
  -H "Authorization: Bearer $CLUSTR_ORG_KEY" \
  -H "X-Clustr-Tenant: client-1234"

A FAILED job carries failure_reason. To see which URLs did not make it, call List Job Items with GET /api/public/jobs/{id}/items.Prefer a push? Set an organization webhook once and wait for job.completed.

Read the paths

Search the workspace’s opportunities with Search Opportunities.

curl "$CLUSTR/api/public/network/search/opportunities?page=1&page_size=100" \
  -H "Authorization: Bearer $CLUSTR_ORG_KEY" \
  -H "X-Clustr-Tenant: client-1234"

Raise page while has_more is true. Add job_id=$JOB_ID to see only what this job found. Other filters, such as domains, narrow the list.

What next

Watch your volume: Usage and limits.
Rename, suspend or delete the workspace: Managing workspaces.

Guides

Organization API

Endpoints

Enterprise quickstart

What next

​What next

What next