Read full entity detail by exact slug, URL, or domain

View as Markdown
Exact read: returns the full detail of the one entity a slug, URL, or domain proves, and 404 or 409 instead of guessing. To identify a company by name and clues, use the POST lookup on this path (CLI entities lookup). Detail qualifiers and visibility rules apply. UUIDs use the item route; id query parameters are rejected. Changed slugs redirect canonically. A signed-in user's read charges one view per distinct returned record against the monthly entity or person view allowance; a repeat read of the same record in the month is free, and an exhausted cap answers 429 with Retry-After. Service-credential (client secret or admin API key) and anonymous reads are never charged.

Query parameters

slugstringOptionalformat: "^[a-z0-9_-]+$"<=255 characters
Exact entity slug.
companySlugstringOptionalformat: "^[a-z0-9_-]+$"<=255 characters

Provider slug for Product/Service slug lookup. Historically named companySlug; providerTypeRecord can narrow this to Company, Nonprofit, or Government routes.

providerTypeRecordstringOptional
Concrete provider type qualifier for a Product/Service provider route; group-only Organization is invalid. Use with companySlug when resolving `/companies/{slug}/products-services/{product}`, `/non-profits/{slug}/products-services/{product}`, or `/government/{slug}/products-services/{product}`.
urlstringOptional

Entity URL matched by host and path unless urlMatchMode=domain.

urlTypestringOptional

URL type qualifier. List the accepted tokens with GET /v1/lookup/url-types (CLI: lookup url-types list).

urlMatchModestringOptional

URL matching mode: hostPath (default for url) or domain. Omit when urlDomain is supplied; urlDomain selects domain mode automatically.

typeRecordstringOptional

Concrete entity type qualifier; group-only Organization is invalid. List the accepted concrete tokens and their aliases with GET /v1/entities/types (CLI: entities types list).

namestringOptional
Primary entity name candidate.
nameBrandstringOptional
Brand name candidate.
nameLegalstringOptional
Legal name candidate.
locationstringOptional

Location candidate: city, state, or country.

urlDomainstringOptional
Website domain candidate without protocol or path.
permitMonogrambooleanOptional
Allow generated monogram logo fallback.
includePrivatebooleanOptional

Includes hidden or off-sitemap entities and hidden research snippets when the caller has private-visibility authority.

Response headers

X-RateLimit-Limitinteger

Requests allowed per client IP in the current rate-limit window.

X-RateLimit-Remaininginteger

Requests left before the tightest applicable rate-limit bucket rejects.

X-RateLimit-Resetinteger

Seconds until the exhausted rate-limit bucket admits another request; 0 when none is exhausted.

Response

Entity detail as canonical JSON or the same data rendered as compact text/plain.

coreobject
Core entity identity, naming, status, image, and source metadata.
enrichmentobject

Entity enrichment: addresses, classification, funding summary, text, and URL links.

fundraiseRoundlist of objects
Fundraise rounds associated with this entity.
newsArticlelist of objects
News articles associated with this entity.
personlist of objects
People associated with this entity.
relationshiplist of objects
Entity relationships.
researchobject

Combined research disclosure: governed detail rows, snippets, and accelerator participation.

sitemapobject

Sub-route eligibility computed once at the persistence boundary.

uniqueIdlist of objects
External registry identifiers associated with this entity.
publicUrlstring or nullOptional
Absolute canonical public URL when this detail has a renderable public route.

Errors

400
Bad Request Error
404
Not Found Error
406
Not Acceptable Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error