entities

Endpoints 205

List entity
GET /v2/entities
Create entity
POST /v2/entities
Search entity
GET /v2/entities/search
Get stats
GET /v2/entities/stats
Check slug
GET /v2/entities/check-slug
Collection templates
GET /v2/entities/collection-templates
Get capital graph public portfolio
GET /v2/entities/public/{slug}/portfolio
Get public investment evidence
GET /v2/entities/public/{slug}/investment-evidence
Get public profile
GET /v2/entities/public/{slug}
Get sfrs statements
GET /v2/entities/{id}/sfrs-statements
Compare companies
GET /v2/entities/compare
Resolve public ticker
GET /v2/entities/public/by-ticker/{ticker}
Get profile
GET /v2/entities/{id}/profile
Create profile
POST /v2/entities/{id}/profile
Update profile
PATCH /v2/entities/{id}/profile
Get reporter profile availability
GET /v2/entities/{id}/reporter-profiles
Get capabilities
GET /v2/entities/{id}/capabilities
List integrations
GET /v2/entities/{id}/integrations
Get hiring access
GET /v2/entities/{id}/hiring-access
Get decorations
GET /v2/entities/{id}/decorations
Update decorations
PATCH /v2/entities/{id}/decorations
Reset decorations
POST /v2/entities/{id}/decorations/reset
Get email inbox
GET /v2/entities/{id}/email-inbox
Provision email inbox
POST /v2/entities/{id}/email-inbox
Update email inbox
PATCH /v2/entities/{id}/email-inbox
List email inboxes
GET /v2/entities/{id}/email-inboxes
Create email inbox
POST /v2/entities/{id}/email-inboxes
Update email inbox by id
PATCH /v2/entities/{id}/email-inboxes/{inboxId}
List owners
GET /v2/entities/{id}/owners
Add owner
POST /v2/entities/{id}/owners
Delete owner
DEL /v2/entities/{id}/owners/{ownerId}
Update owner
PATCH /v2/entities/{id}/owners/{ownerId}
List financial statements
GET /v2/entities/{id}/financial-statements
Add financial statement
POST /v2/entities/{id}/financial-statements
Delete financial statement
DEL /v2/entities/{id}/financial-statements
List trade references
GET /v2/entities/{id}/trade-references
Add trade reference
POST /v2/entities/{id}/trade-references
Delete trade reference
DEL /v2/entities/{id}/trade-references
Update address
PUT /v2/entities/{id}/addresses/{addressId}
List followers
GET /v2/entities/{id}/followers
Add follower
POST /v2/entities/{id}/followers
Delete follower
DEL /v2/entities/{id}/followers
Search follow access principals
GET /v2/entities/{id}/follow-access/principals
List follow access policies
GET /v2/entities/{id}/follow-access/policies
Grant follow access
PUT /v2/entities/{id}/follow-access/policies
Revoke follow access
DEL /v2/entities/{id}/follow-access/policies
List accessible reports
GET /v2/entities/{id}/follow-access/reports
List reporting periods
GET /v2/entities/{id}/periods
Update reporting settings from periods
PUT /v2/entities/{id}/periods
Create reporting period
POST /v2/entities/{id}/periods
Get reporting settings
GET /v2/entities/{id}/settings
Update reporting settings
PUT /v2/entities/{id}/settings
List roles
GET /v2/entities/{id}/roles
Update role
PUT /v2/entities/{id}/roles
Create role
POST /v2/entities/{id}/roles
Delete role
DEL /v2/entities/{id}/roles
Get peer groups
GET /v2/entities/{id}/peer-groups
Update peer group membership
POST /v2/entities/{id}/peer-groups
Get entity
GET /v2/entities/{id}
Update entity
PUT /v2/entities/{id}
Delete entity
DEL /v2/entities/{id}
Patch entity
PATCH /v2/entities/{id}
Unclaim entity
POST /v2/entities/{id}/unclaim
Claim entity
POST /v2/entities/{id}/claim
Follow entity
POST /v2/entities/{id}/follow
Unfollow entity
DEL /v2/entities/{id}/follow
Upload image
POST /v2/entities/{id}/images
List by entity
GET /v2/entities/{entityId}/portfolios
Get entity role
GET /v2/entities/{entityId}/portfolios/role
Get entity execution baseline
GET /v2/entities/{entityId}/execution/baseline
Create entity execution baseline
POST /v2/entities/{entityId}/execution/baseline
Lock entity execution baseline
POST /v2/entities/{entityId}/execution/baseline/lock
Create entity execution baseline correction
POST /v2/entities/{entityId}/execution/baseline/corrections
Generate entity execution baseline summary
POST /v2/entities/{entityId}/execution/baseline/summary/generate
Confirm entity execution baseline summary
POST /v2/entities/{entityId}/execution/baseline/summary/confirm
Create entity execution baseline field
POST /v2/entities/{entityId}/execution/baseline/fields
Update entity execution baseline field
PUT /v2/entities/{entityId}/execution/baseline/fields/{fieldId}
Update entity execution baseline strategic context
PUT /v2/entities/{entityId}/execution/baseline/strategic-context
List viewer groups
GET /v2/entities/{entityId}/viewer-groups
Create viewer groups
POST /v2/entities/{entityId}/viewer-groups
Delete viewer groups
DEL /v2/entities/{entityId}/viewer-groups/{groupId}
Update viewer groups
PATCH /v2/entities/{entityId}/viewer-groups/{groupId}
List members
GET /v2/entities/{entityId}/viewer-groups/{groupId}/members
Add member
POST /v2/entities/{entityId}/viewer-groups/{groupId}/members
Remove member
DEL /v2/entities/{entityId}/viewer-groups/{groupId}/members/{userId}
Deletion impact
GET /v2/entities/{entityId}/viewer-groups/{groupId}/deletion-impact
Get status
GET /v2/entities/{entityId}/reporting-agent-identity
Request registration
POST /v2/entities/{entityId}/reporting-agent-identity
Retry registration
POST /v2/entities/{entityId}/reporting-agent-identity/retry
List collection
GET /v2/entities/{entityId}/collections
Create collection
POST /v2/entities/{entityId}/collections
Get collection
GET /v2/entities/{entityId}/collections/{id}
Delete collection
DEL /v2/entities/{entityId}/collections/{id}
Update collection
PATCH /v2/entities/{entityId}/collections/{id}
Update external sharing
PATCH /v2/entities/{entityId}/collections/{id}/external-sharing
List external sharing audit
GET /v2/entities/{entityId}/collections/{id}/external-sharing/audit
Move collection
POST /v2/entities/{entityId}/collections/{id}/move
Ask agent
POST /v2/entities/{entityId}/collections/{id}/agent/messages
List reports
GET /v2/entities/{entityId}/collections/{id}/reports
Add reports
POST /v2/entities/{entityId}/collections/{id}/reports
Add report
POST /v2/entities/{entityId}/collections/{id}/reports/{reportId}
Remove report
DEL /v2/entities/{entityId}/collections/{id}/reports/{reportId}
List credit info sheets
GET /v2/entities/{entityId}/collections/{id}/credit-info-sheets
Add credit info sheet
POST /v2/entities/{entityId}/collections/{id}/credit-info-sheets
List loan packages
GET /v2/entities/{entityId}/collections/{id}/loan-packages
Add loan package
POST /v2/entities/{entityId}/collections/{id}/loan-packages
List access
GET /v2/entities/{entityId}/collections/{id}/access
Grant access
POST /v2/entities/{entityId}/collections/{id}/access
Revoke access
DEL /v2/entities/{entityId}/collections/{id}/access
Bulk grant access
POST /v2/entities/{entityId}/collections/{id}/access/bulk
Get vault
GET /v2/entities/{entityId}/collections/{id}/vault
Enable vault
POST /v2/entities/{entityId}/collections/{id}/vault
List vault passes
GET /v2/entities/{entityId}/collections/{id}/vault/passes
List activity
GET /v2/entities/{entityId}/collections/{id}/activity
List invites
GET /v2/entities/{entityId}/collections/{id}/invites
Create invite
POST /v2/entities/{entityId}/collections/{id}/invites
Revoke invite
DEL /v2/entities/{entityId}/collections/{id}/invites/{inviteId}
Get a company's verified funding, investors and news
GET /v2/entities/{id}/funding-intel
List a company's portfolio links and whether each is shown
GET /v2/entities/{id}/portfolio-links
Show or hide one portfolio link on the company page
PATCH /v2/entities/{id}/portfolio-links
Get entity startup listing
GET /v2/entities/{entityId}/startup-listing
Create entity startup listing
POST /v2/entities/{entityId}/startup-listing
List entity follow requests
GET /v2/entities/{entityId}/follow-requests
Review follow request
PATCH /v2/entities/{entityId}/follow-requests/{requestId}
List updates
GET /v2/entities/{entityId}/updates
Create update
POST /v2/entities/{entityId}/updates
Create artifact upload session
POST /v2/entities/{entityId}/vault/fundraising/artifacts/upload-session
List fundraising artifacts
GET /v2/entities/{entityId}/vault/fundraising/artifacts
Get fundraising vault catalog
GET /v2/entities/{entityId}/vault/fundraising/catalog
List collection access requests
GET /v2/entities/{entityId}/vault/access-requests
Finalize artifact
POST /v2/entities/{entityId}/vault/fundraising/artifacts/{artifactId}/finalize
Request artifact access grant
POST /v2/entities/{entityId}/vault/fundraising/artifacts/{artifactId}/access-grant
Create fundraising secure link
POST /v2/entities/{entityId}/vault/fundraising/artifacts/{artifactId}/secure-links
Get activity log
GET /v2/entities/{entityId}/activity-log
Get investor readiness score
GET /v2/entities/{entityId}/investor-readiness-score
Create a presigned upload URL for a company logo
POST /v2/entities/{id}/logo/upload-url
Resolve the company logo (public): 302 to the image, or JSON url
GET /v2/entities/{id}/logo
Confirm an uploaded company logo
POST /v2/entities/{id}/logo
Resolve the company banner (public): 302 to the image, or JSON url
GET /v2/entities/{id}/banner
Get a company's capital-market identity
GET /v2/entities/{id}/market-identity
Replace a company's capital-market identity
PUT /v2/entities/{id}/market-identity
Get a source-aware public/private company terminal
GET /v2/entities/{id}/company-terminal
List prebuilt financial model templates for a company
GET /v2/entities/{id}/models
Compute a financial model with filing-prefilled assumptions
GET /v2/entities/{id}/models/{templateKey}
Recompute a financial model with overridden assumptions
POST /v2/entities/{id}/models/{templateKey}/compute
Export a computed financial model as a CSV or XLSX download
POST /v2/entities/{id}/models/{templateKey}/export
List your saved scenarios for a company model template
GET /v2/entities/{id}/models/{templateKey}/scenarios
Save a named scenario for a company model template
POST /v2/entities/{id}/models/{templateKey}/scenarios
Delete one of your saved model scenarios
DEL /v2/entities/{id}/models/{templateKey}/scenarios/{scenarioId}
Update one of your saved model scenarios
PATCH /v2/entities/{id}/models/{templateKey}/scenarios/{scenarioId}
Trailing-twelve-month and fiscal-quarter financials from SEC filings
GET /v2/entities/{id}/financials/full
Get the managed company presentation
GET /v2/entities/{id}/presentation
Create a presentation draft from a template
POST /v2/entities/{id}/presentation
Append an immutable presentation draft version
PUT /v2/entities/{id}/presentation/draft
Replace the draft layout with a source-owned template
POST /v2/entities/{id}/presentation/template
Preview one exact immutable presentation version
GET /v2/entities/{id}/presentation/preview
Validate and publish the current presentation draft
POST /v2/entities/{id}/presentation/publish
List immutable presentation history
GET /v2/entities/{id}/presentation/history
Create a new draft from an immutable historical version
POST /v2/entities/{id}/presentation/rollback
List version-bound presentation preview recipients
GET /v2/entities/{id}/presentation/preview-grants
Share one immutable draft preview with a named recipient
POST /v2/entities/{id}/presentation/preview-grants
Revoke a version-bound presentation preview grant
POST /v2/entities/{id}/presentation/preview-grants/{grantId}/revoke
Open an exact presentation preview shared with this recipient
GET /v2/entities/{id}/presentation/shared-preview/{grantId}
Read entity capital graph
GET /v2/entities/{id}/capital-graph
List portfolio
GET /v2/entities/{id}/portfolio
List investors
GET /v2/entities/{id}/investors
Get status
GET /v2/entities/{entityId}/verification/status
Get history
GET /v2/entities/{entityId}/verification/history
List entity personnel
GET /v2/entities/{id}/personnel
Create entity personnel
POST /v2/entities/{id}/personnel
Search persons
GET /v2/entities/{id}/personnel/search-persons
Update entity personnel
PUT /v2/entities/{id}/personnel/{personnelId}
Delete entity personnel
DEL /v2/entities/{id}/personnel/{personnelId}
List team
GET /v2/entities/{id}/team
List members
GET /v2/entities/{id}/team-members
Remove member
DEL /v2/entities/team/{memberId}
Update member
PATCH /v2/entities/team/{memberId}
Invite member
POST /v2/entities/{id}/team/invite
My invitations
GET /v2/entities/team/invitations/me
My memberships
GET /v2/entities/team/memberships/me
Accept invitation
POST /v2/entities/team/invitations/{invitationId}/accept
Decline invitation
POST /v2/entities/team/invitations/{invitationId}/decline
Get entity wallet
GET /v2/entities/{id}/wallet
Request managed
POST /v2/entities/{id}/wallet/managed
Attach external
PUT /v2/entities/{id}/wallet/external
List entity qrcodes
GET /v2/entities/{entityId}/qr-codes
Create entity qrcodes
POST /v2/entities/{entityId}/qr-codes
List entity filing calendar
GET /v2/entities/{entityId}/filing-calendar
Create entity filing calendar
POST /v2/entities/{entityId}/filing-calendar
Delete entity filing calendar
DEL /v2/entities/{entityId}/filing-calendar/{entryId}
Update entity filing calendar
PATCH /v2/entities/{entityId}/filing-calendar/{entryId}
List entity references
GET /v2/entities/{entityId}/references
Create entity references
POST /v2/entities/{entityId}/references
Create entity and reference
POST /v2/entities/{entityId}/references/create-entity
Delete entity references
DEL /v2/entities/{entityId}/references/{toEntityId}/{referenceType}
Verify entity references
POST /v2/entities/{entityId}/references/{toEntityId}/{referenceType}/verify
List identifiers
GET /v2/entities/{entityId}/identifiers
Create identifier
POST /v2/entities/{entityId}/identifiers
Get scores
GET /v2/entities/{entityId}/scores
Get score status
GET /v2/entities/{entityId}/scores/status
Recalculate scores
POST /v2/entities/{entityId}/scores/recalculate
List vouches
GET /v2/entities/{entityId}/vouches
Upsert vouch
PUT /v2/entities/{entityId}/vouches
Revoke vouch
POST /v2/entities/{entityId}/vouches/revoke
Preview score impact
POST /v2/entities/{entityId}/scores/preview-impact