Suggest classifications for a company
Default classification discovery path for enrichment agents. Returns ranked embedding-derived tag and standardized-code suggestions; empty array means no embedding neighbors. Create joins with the entity classifications create endpoint. A signed-in user is admitted for public entities; callers with private-visibility authority can also resolve hidden or private entities; setting includePrivate=true requires that authority. Signed-in callers without it can access public entities, while hidden entities return 404.
Authentication
AuthorizationBearer
User bearer token: Clerk session JWT, Clerk OAuth access token, or Clerk API key
Path parameters
entityId
Canonical entity UUID
Query parameters
limit
Maximum suggestions to return; default 12, maximum 50.
includePrivate
Includes private or hidden entity suggestions when the caller has private-visibility authority. Omit to use the caller’s default visibility.
Response headers
X-RateLimit-Limit
Requests allowed per client IP in the current rate-limit window.
X-RateLimit-Remaining
Requests left before the tightest applicable rate-limit bucket rejects.
X-RateLimit-Reset
Seconds until the exhausted rate-limit bucket admits another request; 0 when none is exhausted.
Response
OK
alreadyJoined
True when the entity already has a current or historical matching join.
classification
Suggested writable editorial tag or standardized classification code candidate.
creatable
Whether a missing editorial tag value may be created with type plus name instead of tagId.
rank
One-based rank within this suggestion response.
score
Composite embedding similarity score; larger values rank higher.
writable
Whether this suggestion can be joined through the classification mutation endpoint.
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
406
Not Acceptable Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error