Search skmtc…
⌘K
Docs
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Generate
Filter operations
Account
16
Invites
2
Onboarding
7
Owner
349
get
/v1/public/profiles/{handle}
Public profile
post
/v1/public/profiles/{handle}/notes
Profile note
get
/v1/public/profiles/{handle}/live
Public live call
get
/v1/public/scam-count/{handle}
Public scam count
get
/v1/me
Me
post
/v1/onboarding/handle
Claim handle
post
/v1/onboarding/number
Choose number
get
/v1/numbers/offers
Number offers
post
/v1/numbers/change
Number change
post
/v1/numbers/add
Number add
post
/v1/numbers/primary
Number primary
post
/v1/numbers/ring-first
Number ring first
post
/v1/numbers/release
Number release
post
/v1/numbers/release/undo
Number release undo
post
/v1/numbers/local-card/not-now
Local card not now
post
/v1/notices/{id}/read
Read notice
post
/v1/notifications/{id}/ack
Ack notification
post
/v1/settings/ask-rules/{id}/revoke
Revoke ask rule
get
/v1/settings/live-verify
Get live verify
put
/v1/settings/live-verify
Put live verify
get
/v1/owner/phone
Owner phone
post
/v1/owner/phone/verify/start
Start phone verify
post
/v1/owner/phone/verify/confirm
Confirm phone verify
post
/v1/owner/phone/forget
Forget phone
post
/v1/owner/phone/forwarding-moved
Forwarding moved done
post
/v1/phone/verify/code
Start phone verify code
get
/v1/forwarding
Forwarding
put
/v1/forwarding/phone
Set forwarding phone
post
/v1/forwarding/verify
Start forwarding check
post
/v1/asks/{id}/presence
Ask presence
post
/v1/live/{interactionId}/steer
Live steer
get
/v1/live/{interactionId}/stream
Live stream
post
/v1/onboarding/complete
Complete onboarding
get
/v1/contacts
List contacts
put
/v1/contacts/{id}
Upsert contact
get
/v1/blocks
Get blocks
put
/v1/blocks/{kind}
Put block
get
/v1/facts
List facts
post
/v1/facts/{id}/correct
Correct fact
post
/v1/facts/{id}/confirm
Confirm fact
post
/v1/facts/{id}/forget
Forget fact
get
/v1/saved-details
List saved details
post
/v1/saved-details/{id}/forget
Forget saved detail
get
/v1/interactions/{id}/memory-used
Memory used
get
/v1/interactions/{id}/records
Conversation records
get
/v1/ledger/{id}/record
Signed record
get
/v1/shared
Shared
post
/v1/shared/stop
Dont share
get
/v1/contacts/{id}/trust
Person trust
put
/v1/contacts/{id}/trust
Put person trust
get
/v1/settings/learning
Learning
put
/v1/settings/learning
Put learning
get
/v1/interactions/{id}
Interaction
post
/v1/interactions/{id}/caller
Fix caller
post
/v1/contacts/{id}/block
Block contact
post
/v1/teach-backs/{id}/unmerge
Unmerge person
post
/v1/interactions/{id}/spam
Mark spam
post
/v1/interactions/{id}/called-back
Called back
post
/v1/share/scam-card
Share scam card
post
/v1/forget/source
Forget source
post
/v1/interactions/{id}/delete-words
Delete call words
post
/v1/export
Data export
post
/v1/billing/checkout
Checkout
get
/v1/billing/usage-lines
Usage lines
get
/v1/settings/open-booking
Open booking
put
/v1/settings/open-booking
Put open booking
post
/v1/upgrade/offers/{id}/dismiss
Dismiss upgrade offer
get
/v1/connections
List connections
post
/v1/connections/{provider}/start
Start connection
get
/v1/connections/{provider}/callback
Connection callback
post
/v1/connections/{provider}/secret
Put secret connection
put
/v1/connections/{id}
Update connection
delete
/v1/connections/{id}
Delete connection
put
/v1/settings/booking-app
Put booking app
get
/v1/connections/{id}/calendars
List calendars
post
/v1/connections/{id}/crm-resend
Resend crm
post
/v1/connections/{id}/test
Test connection
get
/v1/follow-ups
Follow ups
post
/v1/follow-ups
Create follow up
post
/v1/follow-ups/{id}/send
Send follow up
post
/v1/follow-ups/plan
Reply plan
post
/v1/follow-ups/suggest-times
Suggest times
get
/v1/texts
Texts
get
/v1/texts/{id}
Text thread
post
/v1/texts/{id}/reply
Text reply
get
/v1/answers
Answers
put
/v1/answers
Put answers
post
/v1/answers/import
Import answers
post
/v1/answers/import-file
Import answers file
post
/v1/answers/proposals/{id}
Resolve answer proposal
post
/v1/answers/forget-source
Forget answer source
post
/v1/answers/gaps/{id}
Resolve knowledge gap
post
/v1/answers/try
Try answers
put
/v1/answers/intake
Put intake
get
/v1/answers/leads.csv
Leads csv
get
/v1/me/deliveries
Deliveries
put
/v1/me/deliveries
Put deliveries
post
/v1/me/deliveries/check
Check deliveries
get
/v1/interactions/{id}/drafts
Interaction drafts
get
/v1/drafts/{id}
Draft
put
/v1/drafts/{id}
Edit draft
post
/v1/drafts/{id}/send
Send draft
post
/v1/drafts/{id}/undo
Undo draft
post
/v1/drafts/{id}/discard
Discard draft
get
/v1/email/settings
Email settings
put
/v1/email/settings
Update email settings
post
/v1/email/style-samples
Add style samples
post
/v1/me/device-zone
Report device zone
get
/v1/me/zone
Get zone
put
/v1/me/zone
Set zone
put
/v1/me/zone-mode
Put zone mode
post
/v1/me/zone/confirm
Confirm zone
post
/v1/me/instructions
Create instruction
post
/v1/me/instructions/{id}/remove
Remove instruction
get
/v1/interactions/{id}/media
Call media
get
/v1/settings/text-back
Get text back
put
/v1/settings/text-back
Put text back
get
/v1/inbox/screened
Screened
post
/v1/inbox/screened/{id}/restore
Restore screened
get
/v1/blocked
Blocked numbers
post
/v1/blocked/{id}/unblock
Unblock number
get
/v1/public/numbers/{e164}
Public number lookup
get
/v1/public/number-pages
Public number sitemap index
get
/v1/public/number-areas/{npa}
Public number area
get
/v1/public/number-pages/{shard}
Public number sitemap shard
get
/v1/today
Today
get
/v1/today/week
Week
get
/v1/people
People home
get
/v1/phone-book
Get phone book
post
/v1/phone-book
Sync phone book
post
/v1/phone-book/forget
Forget phone book
get
/v1/me/value
Value report
get
/v1/me/availability
Get availability
put
/v1/me/availability
Put availability
get
/v1/me/breakthrough
Get breakthrough
put
/v1/me/breakthrough
Put breakthrough
get
/v1/chat
Chat page
post
/v1/chat
Send chat
post
/v1/chat/proposals/{id}/confirm
Confirm chat proposal
post
/v1/chat/proposals/{id}/dismiss
Dismiss chat proposal
post
/v1/dictation
Dictation
get
/v1/search
Search
get
/v1/contacts/{id}/timeline
Contact timeline
post
/v1/memory/import/preview
Memory import preview
post
/v1/memory/import/commit
Memory import commit
get
/v1/commitments
Commitments
post
/v1/commitments/{id}/resolve
Resolve commitment
post
/v1/commitments/{id}/calendar
Commitment calendar
get
/v1/settings/bookings
Booking settings
put
/v1/settings/bookings
Put booking settings
get
/v1/public/bookings/{token}
Public booking
post
/v1/public/bookings/{token}/cancel
Cancel public booking
post
/v1/public/bookings/{token}/move
Move public booking
post
/v1/public/bookings/{token}/deposit-paid
Deposit paid public booking
get
/v1/settings/deposits
Deposit settings
put
/v1/settings/deposits
Put deposit settings
post
/v1/bookings/{id}/deposit
Set booking deposit
get
/v1/settings/visits
Visit settings
put
/v1/settings/visits
Put visit settings
post
/v1/bookings/{id}/visit
Set booking visit
post
/v1/public/bookings/{token}/confirm
Confirm public booking
get
/v1/public/profiles/{handle}/book
Public booking slots
post
/v1/public/profiles/{handle}/book
Book public slot
get
/v1/settings/booking-link
Booking link
put
/v1/settings/booking-link
Put booking link
get
/v1/errands
List errands
post
/v1/errands
Create errand
post
/v1/errands/from-file
Errand from file
get
/v1/errands/{id}
Errand
post
/v1/errands/{id}/plan
Update errand plan
post
/v1/errands/{id}/approve
Approve errand
post
/v1/errands/check
Check with contact
post
/v1/errands/{id}/cancel
Cancel errand
post
/v1/errands/{id}/stop
Stop errand
post
/v1/errands/{id}/again
Call errand again
post
/v1/errands/{id}/more
More errand
get
/v1/errand-groups
List errand groups
post
/v1/errands/group
Create errand group
get
/v1/errands/group/{id}
Errand group
post
/v1/errands/group/{id}/plan
Update errand group
post
/v1/errands/group/{id}/cancel
Cancel errand group
post
/v1/errands/group/{id}/approve
Approve errand group
get
/v1/errands/list/{id}
Errand list
post
/v1/errands/list/{id}/approve
Approve errand list
post
/v1/errands/group/{id}/book
Book from errand group
post
/v1/errands/{id}/rehearsal
Rehearse errand
get
/v1/cases
List cases
post
/v1/cases
Create case
get
/v1/cases/{id}
Get case
post
/v1/cases/{id}/approve
Approve case
post
/v1/cases/chase
Chase this
post
/v1/cases/{id}/cancel
Cancel case
post
/v1/cases/{id}/plan
Edit case
post
/v1/cases/{id}/close
Close case
post
/v1/cases/{id}/resume
Resume case
post
/v1/cases/{id}/share
Share case
get
/v1/public/shared-case/{id}
Shared case
get
/v1/settings/business
Get business profile
put
/v1/settings/business
Put business profile
post
/v1/settings/business/import
Import business profile
get
/v1/leads
List leads
post
/v1/leads/{id}/status
Set lead status
get
/v1/settings/speed-to-lead
Get speed to lead
put
/v1/settings/speed-to-lead
Put speed to lead
get
/v1/settings/leads-in
Get leads in
post
/v1/settings/leads-in/rotate
Revoke leads in link
get
/v1/settings/missed-callback
Get missed callback
put
/v1/settings/missed-callback
Put missed callback
get
/v1/settings/recordings
Get recordings
put
/v1/settings/recordings
Put recordings
get
/v1/interactions/{id}/recording
Call recording
get
/v1/contacts/{id}/card
Contact card
post
/v1/contacts/{id}/card
Edit contact card
get
/v1/cards/search
Search cards
get
/v1/calls/add-to-call
Add to call state
post
/v1/calls/add-to-call
Arm add to call
delete
/v1/calls/add-to-call
Disarm add to call
get
/v1/put-out
Get put out
get
/v1/put-out/listing/locations
List listing locations
post
/v1/put-out/listing
Apply listing
post
/v1/put-out/signature
Apply signature
post
/v1/put-out/done
Mark put out
get
/v1/site-chat
Get site chat
put
/v1/site-chat
Put site chat
get
/v1/public/site/{handle}/messages
Site chat read
post
/v1/public/site/{handle}/messages
Site chat send
post
/v1/public/site/{handle}/details
Site chat details
post
/v1/onboarding/heard-about
Heard about
get
/v1/settings/caller-invite
Get caller invite
put
/v1/settings/caller-invite
Put caller invite
get
/v1/settings/emergency-ladder
Get emergency ladder
put
/v1/settings/emergency-ladder
Put emergency ladder
post
/v1/settings/emergency-ladder/backup
Start emergency backup
delete
/v1/settings/emergency-ladder/backup
Remove emergency backup
post
/v1/settings/emergency-ladder/backup/confirm
Confirm emergency backup
get
/v1/settings/team
Get team
put
/v1/settings/team
Put team
post
/v1/onboarding/greeting-audio
Greeting audio
get
/v1/settings/voice
Get caller voice
put
/v1/settings/voice
Put caller voice
post
/v1/settings/voice/preview
Caller voice preview
get
/v1/settings/interpreter
Get interpreter setting
put
/v1/settings/interpreter
Put interpreter setting
post
/v1/live/{interactionId}/interpreter
Live interpreter
get
/v1/first-win
First win
post
/v1/first-win/call
Start first win call
get
/v1/first-win/audio
First win audio
post
/v1/first-win/app-message
First win app message
post
/v1/first-win/marks
First win marks
post
/v1/interactions/{id}/rating
Rate call
get
/v1/byo-line
Byo line
post
/v1/byo-line
Start byo line
delete
/v1/byo-line
Remove byo line
post
/v1/byo-line/confirm
Confirm byo line
put
/v1/byo-line/preset
Set byo preset
put
/v1/byo-line/answer
Set byo answer
post
/v1/byo-line/test
Test byo line
post
/v1/byo-line/resume
Resume byo line
get
/v1/line/calls
Line calls
post
/v1/line/calls
Line call start
post
/v1/line/calls/{id}/end
Line call end
post
/v1/line/texts
Line text
post
/v1/rules/propose
Propose rule
post
/v1/rules/read-back
Read back rule
get
/v1/rules
List rules
post
/v1/rules
Save rule
post
/v1/rules/{id}/remove
Remove rule
post
/v1/rules/{id}/end
Set rule end
post
/v1/rules/rejected
Reject rule
get
/v1/helpers
List helpers
post
/v1/helpers
Invite helper
put
/v1/helpers/{id}
Update helper
post
/v1/helpers/{id}/remove
Remove helper
post
/v1/helpers/accept
Accept helper invite
get
/v1/helpers/accounts
My accounts
post
/v1/helpers/accounts/{ownerId}/leave
Leave helping
post
/v1/helpers/setup
Setup for someone
post
/v1/helpers/accounts/{ownerId}/claim-link
Send claim link
get
/v1/questions
Open questions
post
/v1/helpers/claim
Claim account
get
/v1/protect-parent
Protect parent card
post
/v1/protect-parent/seen
Protect parent seen
get
/v1/parent-line
Parent line
post
/v1/parent-line/resend
Parent line resend
post
/v1/co-helpers
Invite co helper
get
/v1/family
Family
put
/v1/family/{ownerId}/alerts
Set family alerts
post
/v1/practice/{persona}
Run practice
get
/v1/settings/quote
Owner quote
put
/v1/settings/quote
Put owner quote
delete
/v1/settings/quote
Delete owner quote
get
/v1/public/quotes/{trade}/{lang}
Public trade quotes
get
/v1/integrations/webhooks
List webhooks
post
/v1/integrations/webhooks
Create webhook
post
/v1/integrations/webhooks/{id}/remove
Remove webhook
post
/v1/integrations/webhooks/{id}/resume
Resume webhook
post
/v1/integrations/webhooks/{id}/test
Test webhook
get
/v1/integrations/keys
List api keys
post
/v1/integrations/keys
Create api key
post
/v1/integrations/keys/{id}/revoke
Revoke api key
post
/v1/oauth/consent
Oauth consent
post
/v1/oauth/authorize
Oauth authorize
get
/v1/api/inbox
Api inbox
get
/v1/api/contacts
Api contacts
get
/v1/api/bookings
Api bookings
post
/v1/api/notes
Api note
get
/v1/api/me
Api me
post
/v1/api/hooks
Api hook subscribe
delete
/v1/api/hooks/{id}
Api hook unsubscribe
get
/v1/api/events
Api events
post
/v1/api/expecting
Api expect
get
/v1/stats/records
Stats records
get
/v1/forwarding/health
Forwarding health
put
/v1/forwarding/health
Set forwarding health
put
/v1/forwarding/reach-mode
Set reach mode
put
/v1/forwarding/carrier
Set forwarding carrier
post
/v1/forwarding/lookup
Public forwarding lookup
get
/v1/porting
Porting
post
/v1/porting
Start port
post
/v1/porting/check
Check port
post
/v1/porting/cancel
Cancel port
get
/v1/port-outs
Port outs
post
/v1/port-outs/answer
Answer port out
post
/v1/porting/switch
Switch port
post
/v1/forwarding/confirm
Confirm forwarding
put
/v1/me/home-country
Set home country
post
/v1/forwarding/removed
Forwarding removed
get
/v1/me/edge
Edge
get
/v1/me/weekly-summary
Get weekly summary
put
/v1/me/weekly-summary
Put weekly summary
get
/v1/public/v/{handle}/{code}
Public verify code
post
/v1/interactions/{id}/share
Share interaction
post
/v1/interactions/{id}/proof-pack
Proof pack
post
/v1/export/proof-month
Proof month
get
/v1/public/shared/{id}
Shared call
get
/v1/knows
Knows summary
get
/v1/interactions/{id}/learned
Learned from
post
/v1/devices/call-token
Register call token
post
/v1/devices/call-token/revoke
Revoke call token
post
/v1/calls/{callId}/answer
Answer call
get
/v1/calls/{callId}/state
Call state
get
/v1/calls/reach
Pickup reach
post
/v1/owner/talk
Owner talk
post
/v1/owner/talk/end
Owner talk end
get
/v1/kyc/{country}
Kyc status
post
/v1/kyc/{country}
Kyc send
delete
/v1/kyc/{country}
Kyc cancel
post
/v1/kyc/{country}/documents
Kyc upload
get
/v1/kyc/{country}/areas
Kyc areas
Receipts
3
Settings
47
Status
3
Today
20
Upgrade
1
Voiceprints
2
Waitlist
1
Webhooks
6
Owner
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Generate code
Family
get
/v1/family
Request
Base URL:
https://api.vicem.ai
URL:
https://api.vicem.ai/v1/family
Auth:
HTTP bearer
Response
OK
Family
Response
required
members
Set
Family
Alerts
Response[]
required
self
object
nullable
required
shield
object
required
canAdd
boolean
required
addLanguage
string
nullable
required
Changes
No recorded changes to this operation across all 1 revision of this API.