generated: '2026-08-13'
method: derived
source: openapi/instantly-ai-api-v2-openapi.yml
note: 'Entity graph derived from the 30 component schemas and the 173 tagged operations of the published OpenAPI.
  Instantly models relationships with snake_case *_id string fields rather than $ref links between schemas — there
  are no schema-to-schema $refs in components — so the edges below are read from id-reference field names. Workspace
  (referred to as organization_id on most schemas) is the tenancy root: nearly every entity belongs to one. Ids
  are plain UUID strings with no type prefix, so an id alone does not tell an agent what it points at.'
root_entity: Workspace
entity_count: 30
relationship_count: 76
id_convention:
  style: uuid
  prefixed: false
  note: No id prefixes (no cus_/camp_ style). The tenant field is organization_id on most schemas and workspace_id
    on a few (BackgroundJob, CustomPromptTemplate, DFYEmailAccountOrder, WorkspaceMember).
entities:
- name: Account
  schema: components/schemas/Account
  fields: 28
  operations:
  - createAccount
  - deleteAccount
  - disableWarmupForAccounts
  - enableWarmupForAccounts
  - getAccount
  - getCtdStatus
  - getDailyAccountAnalytics
  - getWarmupAnalytics
  - listAccount
  - markAccountFixed
  - moveAccounts
  - patchAccount
  - pauseAccount
  - pauseAccounts
  - resumeAccount
  - testAccountVitals
  operation_count: 16
- name: Campaign
  schema: components/schemas/Campaign
  fields: 38
  id_type: uuid
  operations:
  - activateCampaign
  - addVariables
  - countLaunched
  - createCampaign
  - createFromExport
  - deleteCampaign
  - duplicate
  - exportCampaign
  - getCampaign
  - getCampaignAnalytics
  - getCampaignAnalyticsOverview
  - getCampaignSendingStatus
  - getCampaignStepsAnalytics
  - getDailyCampaignAnalytics
  - listCampaign
  - patchCampaign
  - pauseCampaign
  - searchByContact
  - shareCampaign
  operation_count: 19
- name: Email
  schema: components/schemas/Email
  fields: 34
  id_type: uuid
  operations:
  - countUnreadEmails
  - deleteEmail
  - forwardEmail
  - getEmail
  - listEmail
  - markThreadAsRead
  - patchEmail
  - replyToEmail
  - sendTestEmail
  operation_count: 9
- name: EmailVerification
  schema: components/schemas/EmailVerification
  fields: 6
  operations:
  - checkVerificationStatus
  - createEmailVerification
  operation_count: 2
- name: LeadList
  schema: components/schemas/LeadList
  fields: 6
  id_type: uuid
  operations:
  - createLeadList
  - deleteLeadList
  - getLeadList
  - getVerificationStats
  - listLeadList
  - patchLeadList
  operation_count: 6
- name: InboxPlacementTest
  schema: components/schemas/InboxPlacementTest
  fields: 22
  id_type: uuid
  operations:
  - createInboxPlacementTest
  - deleteInboxPlacementTest
  - getInboxPlacementTest
  - getInboxPlacementTestESPOptions
  - listInboxPlacementTest
  - patchInboxPlacementTest
  operation_count: 6
- name: InboxPlacementAnalytics
  schema: components/schemas/InboxPlacementAnalytics
  fields: 19
  id_type: uuid
  operations:
  - getInboxPlacementAnalytics
  - getInboxPlacementAnalyticsDeliverabilityInsights
  - getInboxPlacementAnalyticsStatsByDate
  - getInboxPlacementAnalyticsStatsByTestId
  - listInboxPlacementAnalytics
  operation_count: 5
- name: InboxPlacementBlacklistAndSpamAssassinReport
  schema: components/schemas/InboxPlacementBlacklistAndSpamAssassinReport
  fields: 12
  id_type: uuid
  operations:
  - getInboxPlacementBlacklistAndSpamAssassinReport
  - listInboxPlacementBlacklistAndSpamAssassinReport
  operation_count: 2
- name: APIKey
  schema: components/schemas/APIKey
  fields: 7
  id_type: uuid
  operations:
  - createAPIKey
  - deleteAPIKey
  - listAPIKey
  operation_count: 3
- name: AccountCampaignMapping
  schema: components/schemas/AccountCampaignMapping
  fields: 4
  operations:
  - getAccountCampaignMapping
  operation_count: 1
- name: Lead
  schema: components/schemas/Lead
  fields: 50
  id_type: uuid
  operations:
  - bulkAddLeads
  - bulkAssignLeads
  - bulkDeleteLeads
  - createLead
  - deleteLead
  - getLead
  - listLeads
  - mergeLeads
  - moveLeadToSubsequence
  - moveLeads
  - patchLead
  - removeLeadFromSubsequence
  - updateLeadInterestStatus
  operation_count: 13
- name: BackgroundJob
  schema: components/schemas/BackgroundJob
  fields: 11
  id_type: string
  operations:
  - getBackgroundJob
  - listBackgroundJob
  operation_count: 2
- name: CustomTag
  schema: components/schemas/CustomTag
  fields: 6
  id_type: uuid
  operations:
  - createCustomTag
  - deleteCustomTag
  - getCustomTag
  - listCustomTag
  - patchCustomTag
  - toggleTagResource
  operation_count: 6
- name: CustomTagMapping
  schema: components/schemas/CustomTagMapping
  fields: 6
  id_type: uuid
  operations:
  - listCustomTagMapping
  operation_count: 1
- name: BlockListEntry
  schema: components/schemas/BlockListEntry
  fields: 5
  id_type: uuid
  operations:
  - createBlockListEntry
  - createblukBlockListEntry
  - deleteBlockListEntry
  - deleteallBlockListEntry
  - deletebulkBlockListEntry
  - downloadBlockListEntry
  - getBlockListEntry
  - listBlockListEntry
  - patchBlockListEntry
  operation_count: 9
- name: LeadLabel
  schema: components/schemas/LeadLabel
  fields: 9
  id_type: uuid
  operations:
  - createLeadLabel
  - deleteLeadLabel
  - getLeadLabel
  - listLeadLabel
  - patchLeadLabel
  - testAiReplyLabelLeadLabels
  operation_count: 6
- name: Workspace
  schema: components/schemas/Workspace
  fields: 17
  id_type: uuid
  operations:
  - addWorkspaceAgencyDomain
  - cancelCurrentWorkspaceRemoval
  - changeWorkspaceOwner
  - deleteWorkspaceDomain
  - getWorkspace
  - getWorkspaceDomainInfo
  - patchWorkspace
  - scheduleCurrentWorkspaceRemoval
  operation_count: 8
- name: SuperSearchEnrichment
  schema: components/schemas/SuperSearchEnrichment
  fields: 10
  id_type: string
  operations:
  - countLeadsFromSupersearch
  - createAIEnrichment
  - createSuperSearchEnrichment
  - enrichLeadsFromSupersearch
  - getAiEnrichmentForResource
  - getEnrichmentForResource
  - getEnrichmentHistory
  - previewLeadsFromSupersearch
  - runEnrichment
  - signalKeywordsFacet
  - updateEnrichmentSettingsForResource
  operation_count: 11
- name: WorkspaceGroupMember
  schema: components/schemas/WorkspaceGroupMember
  fields: 8
  id_type: uuid
  operations:
  - createWorkspaceGroupMember
  - deleteWorkspaceGroupMember
  - getAdminWorkspaceGroupMember
  - getWorkspaceGroupMember
  - listWorkspaceGroupMember
  operation_count: 5
- name: WorkspaceMember
  schema: components/schemas/WorkspaceMember
  fields: 12
  id_type: uuid
  operations:
  - createWorkspaceMember
  - deleteWorkspaceMember
  - getWorkspaceMember
  - listWorkspaceMember
  - patchWorkspaceMember
  operation_count: 5
- name: CampaignSubsequence
  schema: components/schemas/CampaignSubsequence
  fields: 14
  id_type: uuid
  operations:
  - createCampaignSubsequence
  - deleteCampaignSubsequence
  - duplicateSubsequence
  - getCampaignSubsequence
  - getSubsequenceAnalytics
  - getSubsequenceSendingStatus
  - getSubsequenceStepsAnalytics
  - listCampaignSubsequence
  - patchCampaignSubsequence
  - pauseSubsequence
  - resumeSubsequence
  operation_count: 11
- name: AuditLog
  schema: components/schemas/AuditLog
  fields: 16
  id_type: uuid
  operations:
  - listAuditLog
  operation_count: 1
- name: Webhook
  schema: components/schemas/Webhook
  fields: 11
  id_type: uuid
  operations:
  - createWebhook
  - deleteWebhook
  - getWebhook
  - listWebhook
  - listWebhookEventTypes
  - patchWebhook
  - resumeWebhook
  - testWebhook
  operation_count: 8
- name: WebhookEvent
  schema: components/schemas/WebhookEvent
  fields: 16
  id_type: uuid
  operations:
  - getWebhookEvent
  - getWebhookEventsSummary
  - getWebhookEventsSummaryByDate
  - listWebhookEvent
  operation_count: 4
- name: DFYEmailAccountOrder
  schema: components/schemas/DFYEmailAccountOrder
  fields: 7
  operations:
  - cancelDFYEmailAccounts
  - checkDomainsAvailability
  - createDFYEmailAccountOrder
  - generateSimilarDomains
  - listDFYEmailAccountOrder
  - listDFYEmailAccountOrdersAccounts
  - preWarmedUpDomainsList
  operation_count: 7
- name: CustomPromptTemplate
  schema: components/schemas/CustomPromptTemplate
  fields: 17
  id_type: string
  operations: []
  operation_count: 0
  note: Schema is defined but no operation is tagged for it directly.
- name: SalesFlow
  schema: components/schemas/SalesFlow
  fields: 11
  id_type: uuid
  operations: []
  operation_count: 0
  note: Schema is defined but no operation is tagged for it directly.
- name: EmailTemplate
  schema: components/schemas/EmailTemplate
  fields: 6
  id_type: uuid
  operations: []
  operation_count: 0
  note: Schema is defined but no operation is tagged for it directly.
- name: WorkspaceBilling
  schema: components/schemas/WorkspaceBilling
  fields: 0
  operations:
  - getWorkspacePlanDetails
  - getWorkspaceSubscriptionDetails
  operation_count: 2
- name: CRMActions
  schema: components/schemas/CRMActions
  fields: 0
  operations:
  - deletePhoneNumber
  - listPhoneNumbers
  operation_count: 2
relationships:
- from: Email
  to: Workspace
  type: belongs_to
  via: organization_id
- from: Email
  to: Campaign
  type: belongs_to
  via: campaign_id
- from: Email
  to: CampaignSubsequence
  type: belongs_to
  via: subsequence_id
- from: Email
  to: LeadList
  type: belongs_to
  via: list_id
- from: Email
  to: Lead
  type: belongs_to
  via: lead_id
- from: LeadList
  to: Workspace
  type: belongs_to
  via: organization_id
- from: InboxPlacementTest
  to: Workspace
  type: belongs_to
  via: organization_id
- from: InboxPlacementTest
  to: Campaign
  type: belongs_to
  via: campaign_id
- from: InboxPlacementAnalytics
  to: Workspace
  type: belongs_to
  via: organization_id
- from: InboxPlacementAnalytics
  to: InboxPlacementTest
  type: belongs_to
  via: test_id
- from: InboxPlacementBlacklistAndSpamAssassinReport
  to: Workspace
  type: belongs_to
  via: organization_id
- from: InboxPlacementBlacklistAndSpamAssassinReport
  to: InboxPlacementTest
  type: belongs_to
  via: test_id
- from: APIKey
  to: Workspace
  type: belongs_to
  via: organization_id
- from: AccountCampaignMapping
  to: Campaign
  type: belongs_to
  via: campaign_id
- from: Lead
  to: CampaignSubsequence
  type: belongs_to
  via: subsequence_id
- from: Lead
  to: LeadList
  type: belongs_to
  via: list_id
- from: BackgroundJob
  to: Workspace
  type: belongs_to
  via: workspace_id
- from: CustomTag
  to: Workspace
  type: belongs_to
  via: organization_id
- from: CustomTagMapping
  to: CustomTag
  type: belongs_to
  via: tag_id
- from: CustomTagMapping
  to: Workspace
  type: belongs_to
  via: organization_id
- from: BlockListEntry
  to: Workspace
  type: belongs_to
  via: organization_id
- from: LeadLabel
  to: Workspace
  type: belongs_to
  via: organization_id
- from: SuperSearchEnrichment
  to: Workspace
  type: belongs_to
  via: organization_id
- from: WorkspaceGroupMember
  to: Workspace
  type: belongs_to
  via: admin_workspace_id
- from: WorkspaceGroupMember
  to: Workspace
  type: belongs_to
  via: sub_workspace_id
- from: WorkspaceMember
  to: Workspace
  type: belongs_to
  via: workspace_id
- from: AuditLog
  to: Workspace
  type: belongs_to
  via: organization_id
- from: AuditLog
  to: APIKey
  type: belongs_to
  via: api_key_id
- from: AuditLog
  to: Campaign
  type: belongs_to
  via: campaign_id
- from: AuditLog
  to: Webhook
  type: belongs_to
  via: webhook_id
- from: AuditLog
  to: CampaignSubsequence
  type: belongs_to
  via: subsequence_id
- from: AuditLog
  to: LeadList
  type: belongs_to
  via: list_id
- from: WebhookEvent
  to: Workspace
  type: belongs_to
  via: organization_id
- from: DFYEmailAccountOrder
  to: Workspace
  type: belongs_to
  via: workspace_id
- from: CustomPromptTemplate
  to: Workspace
  type: belongs_to
  via: workspace_id
- from: SalesFlow
  to: Workspace
  type: belongs_to
  via: organization_id
- from: SalesFlow
  to: LeadList
  type: belongs_to
  via: list_id
- from: SalesFlow
  to: Campaign
  type: belongs_to
  via: campaign_id
- from: Workspace
  to: Email
  type: has_many
  via: organization_id
- from: Campaign
  to: Email
  type: has_many
  via: campaign_id
- from: CampaignSubsequence
  to: Email
  type: has_many
  via: subsequence_id
- from: LeadList
  to: Email
  type: has_many
  via: list_id
- from: Lead
  to: Email
  type: has_many
  via: lead_id
- from: Workspace
  to: LeadList
  type: has_many
  via: organization_id
- from: Workspace
  to: InboxPlacementTest
  type: has_many
  via: organization_id
- from: Campaign
  to: InboxPlacementTest
  type: has_many
  via: campaign_id
- from: Workspace
  to: InboxPlacementAnalytics
  type: has_many
  via: organization_id
- from: InboxPlacementTest
  to: InboxPlacementAnalytics
  type: has_many
  via: test_id
- from: Workspace
  to: InboxPlacementBlacklistAndSpamAssassinReport
  type: has_many
  via: organization_id
- from: InboxPlacementTest
  to: InboxPlacementBlacklistAndSpamAssassinReport
  type: has_many
  via: test_id
- from: Workspace
  to: APIKey
  type: has_many
  via: organization_id
- from: Campaign
  to: AccountCampaignMapping
  type: has_many
  via: campaign_id
- from: CampaignSubsequence
  to: Lead
  type: has_many
  via: subsequence_id
- from: LeadList
  to: Lead
  type: has_many
  via: list_id
- from: Workspace
  to: BackgroundJob
  type: has_many
  via: workspace_id
- from: Workspace
  to: CustomTag
  type: has_many
  via: organization_id
- from: CustomTag
  to: CustomTagMapping
  type: has_many
  via: tag_id
- from: Workspace
  to: CustomTagMapping
  type: has_many
  via: organization_id
- from: Workspace
  to: BlockListEntry
  type: has_many
  via: organization_id
- from: Workspace
  to: LeadLabel
  type: has_many
  via: organization_id
- from: Workspace
  to: SuperSearchEnrichment
  type: has_many
  via: organization_id
- from: Workspace
  to: WorkspaceGroupMember
  type: has_many
  via: admin_workspace_id
- from: Workspace
  to: WorkspaceGroupMember
  type: has_many
  via: sub_workspace_id
- from: Workspace
  to: WorkspaceMember
  type: has_many
  via: workspace_id
- from: Workspace
  to: AuditLog
  type: has_many
  via: organization_id
- from: APIKey
  to: AuditLog
  type: has_many
  via: api_key_id
- from: Campaign
  to: AuditLog
  type: has_many
  via: campaign_id
- from: Webhook
  to: AuditLog
  type: has_many
  via: webhook_id
- from: CampaignSubsequence
  to: AuditLog
  type: has_many
  via: subsequence_id
- from: LeadList
  to: AuditLog
  type: has_many
  via: list_id
- from: Workspace
  to: WebhookEvent
  type: has_many
  via: organization_id
- from: Workspace
  to: DFYEmailAccountOrder
  type: has_many
  via: workspace_id
- from: Workspace
  to: CustomPromptTemplate
  type: has_many
  via: workspace_id
- from: Workspace
  to: SalesFlow
  type: has_many
  via: organization_id
- from: LeadList
  to: SalesFlow
  type: has_many
  via: list_id
- from: Campaign
  to: SalesFlow
  type: has_many
  via: campaign_id