Documentation
Documentation

Overview

Spore docs

Start here

Getting startedInstall the CLIAuthentication and keys

Build

Search and filtersSegments and the loopEnrichment lifecycle

Recipes

Recipe: search to a live SegmentRecipe: enrich without a segmentRecipe: land your own research

Connect

Events

Account

Credits and billing

Reference

Conventions
API reference
Export the organization's Operation calls POSTPage the organization's Operation calls GETExport the organization's recorded acts POSTPage the organization's recorded acts GETCancel an enrichment launch POSTRead a vocabulary: tools, filters, knowledge, or NACE GETPublish a staged Commons Generation POSTRestore the retained previous Commons Generation POSTPage the organization's Companies GETCorrect a Company's Core under Spore-If-Match PATCHDelete a Company DELETERead everything you know about one Company GETRead Legal entity data for Companies you hold POSTFind Legal entities in the Commons POSTFold one Company into another POSTMint Companies from your own data, or attach rows to Companies you hold POSTPromote a declared current Fact into Company Core POSTRead one Company GETMeasure requested fields over a set of Companies POSTRun a native enrichment POSTPoll an enrichment GETFollow the organization's durable events stream GETPage a Job's frozen target list GETCreate an API key and reveal its secret once POSTRevoke an organization API key POSTList per-item enrichment outcomes GETDeclare a namespace and its fields before recording into them POSTDelete a declaration while nothing stands on it DELETERead your Catalog GETRecord what you observed about a Company or concluded about a Segment POSTUnlock every Legal entity a search matched POSTSearch the Commons: count, analytics, and a minted sample POSTPage a Segment's members, with the exact count GETName a live filter over your Companies POSTDelete a Segment DELETERead what you have concluded about one Segment GETRename a Segment, or change what it means, under Spore-If-Match PATCHRead a Segment's name and filter GETPage the organization's Segments GETPage the organization's credit ledger GETRead the balance and this key's spend bounds GET
API reference

Correct a Company's Core under Spore-If-Match

Changes the name or operating country in place; each supplied set of activities, identifiers, or domains replaces the whole set, so a Company never loses its last activity, its last identifier-or-domain, or its primary. An identifier that stays keeps its verification; one another Company holds is refused naming the holder. A stale `Spore-If-Match` is refused with the current Company and its ETag. Free.

PATCH
/api/v1/companies/{companyId}

Changes the name or operating country in place; each supplied set of activities, identifiers, or domains replaces the whole set, so a Company never loses its last activity, its last identifier-or-domain, or its primary. An identifier that stays keeps its verification; one another Company holds is refused naming the holder. A stale Spore-If-Match is refused with the current Company and its ETag.

Free.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

companyId*string

The Company's opaque id.

Formatuuid

Header Parameters

Spore-If-Match*string

The resource's current ETag, so a write cannot overwrite a change made by another caller. The standard conditional headers (If-Match and its kin) are refused on writes (ADR-0062).

Idempotency-Key*string

Required for writes. Reusing this key with the same input replays the original response.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/v1/companies/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Spore-If-Match: string" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "companyId": "7f9c2a14-3b6e-4d51-9a2f-1c8e5b0d47a3",    "name": "Coop Eesti Keskühistu",    "domains": [      {        "domain": "coop.ee",        "primary": true      },      {        "domain": "ecoop.ee"      }    ]  }'
{  "id": "7f9c2a14-3b6e-4d51-9a2f-1c8e5b0d47a3",  "name": "Coop Eesti Keskühistu",  "country": "EE",  "origin": "external",  "verified": false,  "unlocked": false,  "legalEntityId": null,  "activities": [    {      "code": "4711",      "precision": "class",      "source": {        "scheme": "nace21",        "code": "4711"      },      "primary": true    }  ],  "identifiers": [    {      "kind": "registration",      "country": "EE",      "scheme": "ee-registrikood",      "value": "10093971",      "primary": true,      "verifiedAt": null    },    {      "kind": "organization_system",      "system": "hubspot",      "value": "8842001",      "primary": false    }  ],  "domains": [    {      "domain": "coop.ee",      "primary": true    }  ],  "etag": "\"2\"",  "createdAt": "2026-09-02T00:00:00.000Z",  "updatedAt": "2026-09-02T00:00:00.000Z"}

Page the organization's Companies GET

Lists the organization's Companies newest first under an opaque cursor, with their Core: name, country, activities, identifiers, and domains. Narrow by operating `country` or a name fragment `q`. Ids are opaque and never reused; a Company of another organization is invisible. Free.

Delete a Company DELETE

Deletes the Company and its identifiers, activities, and domains outright; the id then reads as not found and the allowance count drops. Without `confirm=true` the call refuses with the counts it would remove. An Unlock grant on the Company's Legal entity is never deleted. Free.

companyId*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
name?string
Length1 <= length <= 500
country?string
Length2 <= length <= 2
activities?array<>
Items1 <= items <= 20
identifiers?array<|>
Itemsitems <= 20
domains?array<>
Itemsitems <= 20