People & Companies developer access
The universal facts about people and companies, shared by every Vision app: names, contact details, addresses, affiliations, consent, and a change feed.
- Owner
- Vision People & Companies
- Lifecycle
- preview
- Runtime
- restricted
- App entitlement
- directory
- Audience
- Vision-issued credential with the directory entitlement
- Workspace
- Directory workspace required
Authority boundary
Directory owns these facts, its workspace authorization, and its change feed. Apps store a record's id and keep their own data; app-specific fields go in namespaced extensions.
Complete preview contract: Every operation and MCP capability in the approved definitions below is documented. The lifecycle and runtime labels describe stability and availability, not partial catalog coverage.
People & Companies API
- Owning App
- People & Companies
- Contract version
- 1.5.0
- Audience
- Vision-issued credential with the directory entitlement
- Workspace binding
- Directory workspace required
Download the authoritative OpenAPI 3.1 definition
62 operations
Generated from Vision People & Companies (Directory) API 1.5.0
- GET/health/live
Process is up
No bearer scope declaredFull operation reference → Database reachable and this build's newest migration applied
No bearer scope declaredFull operation reference →What this App says about someone leaving
No bearer scope declaredFull operation reference →- GET/api/v1/meta
Service description
No bearer scope declaredFull operation reference → This document
No bearer scope declaredFull operation reference →List or search people
Full operation reference →directory:people:read- POST/api/v1/people
Create a person
Full operation reference →directory:people:write Get up to 100 people by id, in one call; ids with no record come back in missing
Full operation reference →directory:people:readGet a person by id
Full operation reference →directory:people:read- PATCH/api/v1/people/{id}
Change a person (absent fields are left alone)
Full operation reference →directory:people:write - DELETE/api/v1/people/{id}
Delete a person (soft: restorable)
Full operation reference →directory:people:write Restore a deleted person
Full operation reference →directory:people:writeRecord a contact permission (appends to the history)
Full operation reference →directory:people:writeSet an app's own extension field
Full operation reference →directory:extensions:{appId}:writeRemove an app's own extension field
Full operation reference →directory:extensions:{appId}:writeAdd emails
Full operation reference →directory:people:writeRemove one of the emails
Full operation reference →directory:people:writeMake it the main one (only one per record)
Full operation reference →directory:people:writeAdd phones
Full operation reference →directory:people:writeRemove one of the phones
Full operation reference →directory:people:writeMake it the main one (only one per record)
Full operation reference →directory:people:writeAdd social links
Full operation reference →directory:people:writeRemove one of the social links
Full operation reference →directory:people:writeAdd addresses
Full operation reference →directory:people:writeChange an address in place (absent fields are left alone, null clears one)
Full operation reference →directory:people:writeRemove one of the addresses
Full operation reference →directory:people:writeMake it the main one (only one per record)
Full operation reference →directory:people:writeList or search companies
Full operation reference →directory:companies:readCreate a company
Full operation reference →directory:companies:writeGet up to 100 companies by id, in one call; ids with no record come back in missing
Full operation reference →directory:companies:readGet a company by id
Full operation reference →directory:companies:readChange a company (absent fields are left alone)
Full operation reference →directory:companies:write- DELETE/api/v1/companies/{id}
Delete a company (soft: restorable)
Full operation reference →directory:companies:write Restore a deleted company
Full operation reference →directory:companies:writeRecord a contact permission (appends to the history)
Full operation reference →directory:companies:writeSet an app's own extension field
Full operation reference →directory:extensions:{appId}:writeRemove an app's own extension field
Full operation reference →directory:extensions:{appId}:writeAdd emails
Full operation reference →directory:companies:writeRemove one of the emails
Full operation reference →directory:companies:writeMake it the main one (only one per record)
Full operation reference →directory:companies:writeAdd phones
Full operation reference →directory:companies:writeRemove one of the phones
Full operation reference →directory:companies:writeMake it the main one (only one per record)
Full operation reference →directory:companies:writeAdd social links
Full operation reference →directory:companies:writeRemove one of the social links
Full operation reference →directory:companies:writeAdd addresses
Full operation reference →directory:companies:writeChange an address in place (absent fields are left alone, null clears one)
Full operation reference →directory:companies:writeRemove one of the addresses
Full operation reference →directory:companies:writeMake it the main one (only one per record)
Full operation reference →directory:companies:writeLink a person to a company (role, start and end dates)
Full operation reference →directory:people:writeChange a role or its dates (set endedOn to end it and keep the history)
Full operation reference →directory:people:writeRemove a link made by mistake (no history kept)
Full operation reference →directory:people:writeChanges since a sequence number, oldest first; each caller sees only the record types it may read
Full operation reference →directory:people:readdirectory:companies:readRecords that already use an email or phone, or companies with the same name or website domain (for Import previews); names only record types the caller may read. Likely matches: nothing is merged
Full operation reference →directory:people:readdirectory:companies:readScreens for Vision Core (filtered to the caller)
Full operation reference →directory:people:readPeople list screen
Full operation reference →directory:people:readPerson screen
Full operation reference →directory:people:readCompanies list screen
Full operation reference →directory:companies:readCompany screen
Full operation reference →directory:companies:readCompany picker
Full operation reference →directory:companies:readCore form commands for people
Full operation reference →directory:people:writeCore form commands for companies
Full operation reference →directory:companies:write
Publication evidence
This page is generated from the approval registry. Contract checksums, source drift, security declarations, scopes, references, and operation identifiers are verified before publication. A production documentation deployment remains a separate approval and rollback gate.