Skip to main content

SemaswiftDocs

Auth API
Billing API
Voice API
Ticketing API
Engagements API
Uploads API
Automation API
Notifications API
Reports API
Surveys API
CRM API

Introduction
AddCollaborator grants collaborator access via SpiceDB.
CreateAccount creates a new Account.
DeleteAccount soft-deletes an Account. Accounts with open child hierarchy or active contacts can be deleted — the references remain as historical context.
GetAccountDescendants returns a flat list of all accounts below this one in the hierarchy, useful for rollup queries.
GetAccountHierarchy returns the full tree containing this account (all ancestors + all descendants).
GetAccount retrieves a single Account.
ListAccountContacts returns all contacts linked to this account via primary or secondary memberships, merged.
ListAccounts returns a paginated list of Accounts.
ListCollaborators returns all users with collaborator access to this account.
MergeAccounts merges source into target, rewriting FKs and soft- deleting source.
RemoveCollaborator revokes collaborator access.
SearchAccounts runs a full-text query across name/website/phone.
SetOwner changes the account owner. Updates SpiceDB relations.
UpdateAccount applies a partial update.
CRMActivityService_GetActivity
CRMActivityService_ListAccountActivities
CRMActivityService_ListContactActivities
CRMContactService_AddContactCollaborator
CRMContactService_AttachSecondaryAccount
CRMContactService_ConvertLead
CRMContactService_CreateContact
CRMContactService_DeleteContact
CRMContactService_DetachSecondaryAccount
CRMContactService_GetContact
Internal-only (gateway routes /internal/v1/*): no per-row SpiceDB, tenant isolation from context. Used by service-to-service callers on the hot path.
CRMContactService_ListContactAccounts
CRMContactService_ListContactCollaborators
CRMContactService_ListContacts
CRMContactService_MergeContacts
CRMContactService_RemoveContactCollaborator
CRMContactService_ResolveContactByChannel
CRMContactService_SearchContacts
CRMContactService_SetContactOwner
CRMContactService_UpdateContact
CRMCustomFieldService_ArchiveCustomFieldDefinition
CRMCustomFieldService_CreateCustomFieldDefinition
CRMCustomFieldService_GetCustomFieldDefinition
CRMCustomFieldService_ListCustomFieldDefinitions
CRMCustomFieldService_ReorderCustomFieldDefinitions
CRMCustomFieldService_UpdateCustomFieldDefinition
CRMNoteService_CreateNote
CRMNoteService_DeleteNote
CRMNoteService_GetNote
CRMNoteService_ListNotes
CRMNoteService_PinNote
CRMNoteService_UnpinNote
CRMNoteService_UpdateNote

CRMCustomFieldService_GetCustomFieldDefinition

CRMCustomFieldService_GetCustomFieldDefinition

GET /api/v1/crm/custom-fields/:id

CRMCustomFieldService_GetCustomFieldDefinition

Request

Responses

200
default

A successful response.

An unexpected error response.

CRMCustomFieldService_CreateCustomFieldDefinition

CRMCustomFieldService_ListCustomFieldDefinitions

Documentation

Getting Started
Authentication
API Reference

API Services

Auth API
Billing API
Voice API
Ticketing API
Reports API
Notifications API
Surveys API
CRM API

More

Changelog
GitHub
Support

Copyright © 2026 Semaswift. All rights reserved.