@graph8/sdk 0.251.0 → 0.262.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -2
- package/dist/cli.js +216 -0
- package/dist/index.d.mts +105 -7
- package/dist/index.d.ts +105 -7
- package/dist/index.js +44 -3
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +44 -3
- package/dist/index.mjs.map +1 -1
- package/dist/react.d.mts +103 -7
- package/dist/react.d.ts +103 -7
- package/dist/react.js +62 -11
- package/dist/react.js.map +1 -1
- package/dist/react.mjs +53 -12
- package/dist/react.mjs.map +1 -1
- package/dist/types/README.md +7 -0
- package/dist/types/agency.d.ts +20 -0
- package/dist/types/agentSetup.d.ts +57 -0
- package/dist/types/api.d.ts +127 -0
- package/dist/types/appClient.d.ts +99 -0
- package/dist/types/appPlatform.d.ts +269 -0
- package/dist/types/appTokens.d.ts +125 -0
- package/dist/types/apps.d.ts +130 -0
- package/dist/types/audiences.d.ts +88 -0
- package/dist/types/calendar.d.ts +55 -0
- package/dist/types/campaigns.d.ts +61 -0
- package/dist/types/chat.d.ts +35 -0
- package/dist/types/cli.d.ts +14 -0
- package/dist/types/companies.d.ts +123 -0
- package/dist/types/contacts.d.ts +200 -0
- package/dist/types/copilot.d.ts +31 -0
- package/dist/types/core.d.ts +1052 -0
- package/dist/types/deals.d.ts +215 -0
- package/dist/types/enrich.d.ts +51 -0
- package/dist/types/fields.d.ts +84 -0
- package/dist/types/forms.d.ts +16 -0
- package/dist/types/http.d.ts +141 -0
- package/dist/types/inbox.d.ts +123 -0
- package/dist/types/index.d.ts +63 -0
- package/dist/types/intent.d.ts +196 -0
- package/dist/types/lists.d.ts +44 -0
- package/dist/types/mailboxes.d.ts +240 -0
- package/dist/types/marketplace.d.ts +62 -0
- package/dist/types/meetings.d.ts +70 -0
- package/dist/types/newsletter.d.ts +212 -0
- package/dist/types/notes.d.ts +57 -0
- package/dist/types/objects.d.ts +281 -0
- package/dist/types/pipelines.d.ts +135 -0
- package/dist/types/quotes.d.ts +143 -0
- package/dist/types/react.d.ts +978 -0
- package/dist/types/search.d.ts +99 -0
- package/dist/types/sequences.d.ts +255 -0
- package/dist/types/signals.d.ts +28 -0
- package/dist/types/skills.d.ts +176 -0
- package/dist/types/snippet.d.ts +24 -0
- package/dist/types/studio.d.ts +161 -0
- package/dist/types/tasks.d.ts +101 -0
- package/dist/types/types.d.ts +45 -0
- package/dist/types/utils.d.ts +21 -0
- package/dist/types/version.d.ts +10 -0
- package/dist/types/visitors.d.ts +29 -0
- package/dist/types/voice.d.ts +304 -0
- package/dist/types/webhooks.d.ts +71 -0
- package/dist/types/workflows.d.ts +229 -0
- package/docs/agents.md +748 -0
- package/docs/api/README.md +165 -0
- package/docs/api/accounts.d.ts +396 -0
- package/docs/api/accounts.md +644 -0
- package/docs/api/adCampaigns.d.ts +707 -0
- package/docs/api/adCampaigns.md +1091 -0
- package/docs/api/adCreatives.d.ts +996 -0
- package/docs/api/adCreatives.md +1708 -0
- package/docs/api/agency.d.ts +556 -0
- package/docs/api/agency.md +845 -0
- package/docs/api/agent.d.ts +330 -0
- package/docs/api/agent.md +514 -0
- package/docs/api/agents.d.ts +1622 -0
- package/docs/api/agents.md +2860 -0
- package/docs/api/aiInbox.d.ts +1984 -0
- package/docs/api/aiInbox.md +3490 -0
- package/docs/api/analytics.d.ts +1273 -0
- package/docs/api/analytics.md +2095 -0
- package/docs/api/apiKeys.d.ts +252 -0
- package/docs/api/apiKeys.md +318 -0
- package/docs/api/appDeployments.d.ts +236 -0
- package/docs/api/appDeployments.md +471 -0
- package/docs/api/appDomains.d.ts +171 -0
- package/docs/api/appDomains.md +281 -0
- package/docs/api/appLogs.d.ts +120 -0
- package/docs/api/appLogs.md +159 -0
- package/docs/api/appObjects.d.ts +415 -0
- package/docs/api/appObjects.md +568 -0
- package/docs/api/appPages.d.ts +557 -0
- package/docs/api/appPages.md +796 -0
- package/docs/api/appPlatformTokens.d.ts +123 -0
- package/docs/api/appPlatformTokens.md +172 -0
- package/docs/api/appointments.d.ts +2361 -0
- package/docs/api/appointments.md +3917 -0
- package/docs/api/apps.d.ts +822 -0
- package/docs/api/apps.md +1342 -0
- package/docs/api/assertUpsert.d.ts +286 -0
- package/docs/api/assertUpsert.md +370 -0
- package/docs/api/audienceSyncs.d.ts +259 -0
- package/docs/api/audienceSyncs.md +395 -0
- package/docs/api/brandKit.d.ts +686 -0
- package/docs/api/brandKit.md +1133 -0
- package/docs/api/bugReports.d.ts +181 -0
- package/docs/api/bugReports.md +268 -0
- package/docs/api/by-path.md +3260 -0
- package/docs/api/calendarInvites.d.ts +117 -0
- package/docs/api/calendarInvites.md +148 -0
- package/docs/api/campaignWorkflows.d.ts +152 -0
- package/docs/api/campaignWorkflows.md +200 -0
- package/docs/api/campaigns.d.ts +721 -0
- package/docs/api/campaigns.md +1236 -0
- package/docs/api/channels.d.ts +171 -0
- package/docs/api/channels.md +235 -0
- package/docs/api/cliCampaigns.d.ts +205 -0
- package/docs/api/cliCampaigns.md +256 -0
- package/docs/api/cliPipelines.d.ts +324 -0
- package/docs/api/cliPipelines.md +562 -0
- package/docs/api/clickHouse.d.ts +115 -0
- package/docs/api/clickHouse.md +138 -0
- package/docs/api/companies.d.ts +1636 -0
- package/docs/api/companies.md +2211 -0
- package/docs/api/companyIntelligence.d.ts +299 -0
- package/docs/api/companyIntelligence.md +488 -0
- package/docs/api/contacts.d.ts +2173 -0
- package/docs/api/contacts.md +3143 -0
- package/docs/api/content.d.ts +968 -0
- package/docs/api/content.md +1667 -0
- package/docs/api/contentGridSkills.d.ts +177 -0
- package/docs/api/contentGridSkills.md +271 -0
- package/docs/api/copilot.d.ts +1017 -0
- package/docs/api/copilot.md +1765 -0
- package/docs/api/crmSyncs.d.ts +215 -0
- package/docs/api/crmSyncs.md +301 -0
- package/docs/api/customerSuccess.d.ts +491 -0
- package/docs/api/customerSuccess.md +776 -0
- package/docs/api/deals.d.ts +1697 -0
- package/docs/api/deals.md +2436 -0
- package/docs/api/deliverability.d.ts +418 -0
- package/docs/api/deliverability.md +677 -0
- package/docs/api/desk.d.ts +1765 -0
- package/docs/api/desk.md +3007 -0
- package/docs/api/dialer.d.ts +1185 -0
- package/docs/api/dialer.md +2166 -0
- package/docs/api/dialerAnalytics.d.ts +187 -0
- package/docs/api/dialerAnalytics.md +257 -0
- package/docs/api/documents.d.ts +895 -0
- package/docs/api/documents.md +1440 -0
- package/docs/api/duplicates.d.ts +195 -0
- package/docs/api/duplicates.md +315 -0
- package/docs/api/eSign.d.ts +38 -0
- package/docs/api/eSign.md +54 -0
- package/docs/api/eSignature.d.ts +242 -0
- package/docs/api/eSignature.md +341 -0
- package/docs/api/enrichment.d.ts +3207 -0
- package/docs/api/enrichment.md +5225 -0
- package/docs/api/events.d.ts +115 -0
- package/docs/api/events.md +105 -0
- package/docs/api/fields.d.ts +482 -0
- package/docs/api/fields.md +566 -0
- package/docs/api/forms.d.ts +1012 -0
- package/docs/api/forms.md +1542 -0
- package/docs/api/gtmCampaigns.d.ts +662 -0
- package/docs/api/gtmCampaigns.md +1044 -0
- package/docs/api/gtmContext.d.ts +1187 -0
- package/docs/api/gtmContext.md +2112 -0
- package/docs/api/gtmDeliverability.d.ts +60 -0
- package/docs/api/gtmDeliverability.md +63 -0
- package/docs/api/gtmKnowledgeBase.d.ts +76 -0
- package/docs/api/gtmKnowledgeBase.md +91 -0
- package/docs/api/gtmLaunchHelpers.d.ts +123 -0
- package/docs/api/gtmLaunchHelpers.md +148 -0
- package/docs/api/gtmLibrary.d.ts +448 -0
- package/docs/api/gtmLibrary.md +780 -0
- package/docs/api/health.d.ts +39 -0
- package/docs/api/health.md +58 -0
- package/docs/api/imageLibrary.d.ts +341 -0
- package/docs/api/imageLibrary.md +569 -0
- package/docs/api/imports.d.ts +157 -0
- package/docs/api/imports.md +174 -0
- package/docs/api/inbox.d.ts +709 -0
- package/docs/api/inbox.md +1067 -0
- package/docs/api/install.d.ts +213 -0
- package/docs/api/install.md +317 -0
- package/docs/api/installedApps.d.ts +131 -0
- package/docs/api/installedApps.md +241 -0
- package/docs/api/integrationStatus.d.ts +142 -0
- package/docs/api/integrationStatus.md +205 -0
- package/docs/api/integrations.d.ts +2327 -0
- package/docs/api/integrations.md +3791 -0
- package/docs/api/intent.d.ts +482 -0
- package/docs/api/intent.md +858 -0
- package/docs/api/knowledge.d.ts +501 -0
- package/docs/api/knowledge.md +843 -0
- package/docs/api/knowledgeBase.d.ts +84 -0
- package/docs/api/knowledgeBase.md +96 -0
- package/docs/api/landingPages.d.ts +1411 -0
- package/docs/api/landingPages.md +2488 -0
- package/docs/api/leads.d.ts +133 -0
- package/docs/api/leads.md +180 -0
- package/docs/api/library.d.ts +217 -0
- package/docs/api/library.md +338 -0
- package/docs/api/linkedIn.d.ts +227 -0
- package/docs/api/linkedIn.md +289 -0
- package/docs/api/linkedInOutreach.d.ts +727 -0
- package/docs/api/linkedInOutreach.md +990 -0
- package/docs/api/lists.d.ts +1106 -0
- package/docs/api/lists.md +1609 -0
- package/docs/api/logs.d.ts +71 -0
- package/docs/api/logs.md +70 -0
- package/docs/api/mailboxes.d.ts +1050 -0
- package/docs/api/mailboxes.md +1690 -0
- package/docs/api/marketingIntelligence.d.ts +256 -0
- package/docs/api/marketingIntelligence.md +454 -0
- package/docs/api/marketplace.d.ts +3173 -0
- package/docs/api/marketplace.md +5953 -0
- package/docs/api/mcp.d.ts +69 -0
- package/docs/api/mcp.md +69 -0
- package/docs/api/me.d.ts +54 -0
- package/docs/api/me.md +56 -0
- package/docs/api/meetings.d.ts +539 -0
- package/docs/api/meetings.md +747 -0
- package/docs/api/newsletter.d.ts +1613 -0
- package/docs/api/newsletter.md +2746 -0
- package/docs/api/notes.d.ts +517 -0
- package/docs/api/notes.md +888 -0
- package/docs/api/notifications.d.ts +94 -0
- package/docs/api/notifications.md +105 -0
- package/docs/api/objects.d.ts +621 -0
- package/docs/api/objects.md +1098 -0
- package/docs/api/openSearch.d.ts +234 -0
- package/docs/api/openSearch.md +297 -0
- package/docs/api/ops.d.ts +299 -0
- package/docs/api/ops.md +339 -0
- package/docs/api/orgGovernance.d.ts +393 -0
- package/docs/api/orgGovernance.md +623 -0
- package/docs/api/orgVideos.d.ts +184 -0
- package/docs/api/orgVideos.md +252 -0
- package/docs/api/organizationSettings.d.ts +626 -0
- package/docs/api/organizationSettings.md +911 -0
- package/docs/api/phoneNumbers.d.ts +484 -0
- package/docs/api/phoneNumbers.md +777 -0
- package/docs/api/profile.d.ts +329 -0
- package/docs/api/profile.md +540 -0
- package/docs/api/programmaticPages.d.ts +400 -0
- package/docs/api/programmaticPages.md +626 -0
- package/docs/api/providerDomains.d.ts +866 -0
- package/docs/api/providerDomains.md +1446 -0
- package/docs/api/providerUsage.d.ts +129 -0
- package/docs/api/providerUsage.md +186 -0
- package/docs/api/public.d.ts +69 -0
- package/docs/api/public.md +78 -0
- package/docs/api/publicCopilot.d.ts +67 -0
- package/docs/api/publicCopilot.md +80 -0
- package/docs/api/publicSignals.d.ts +66 -0
- package/docs/api/publicSignals.md +71 -0
- package/docs/api/publicVisitors.d.ts +97 -0
- package/docs/api/publicVisitors.md +118 -0
- package/docs/api/quotes.d.ts +1564 -0
- package/docs/api/quotes.md +2553 -0
- package/docs/api/radar.d.ts +808 -0
- package/docs/api/radar.md +1431 -0
- package/docs/api/radarReports.d.ts +208 -0
- package/docs/api/radarReports.md +306 -0
- package/docs/api/recordRoles.d.ts +143 -0
- package/docs/api/recordRoles.md +175 -0
- package/docs/api/repos.d.ts +146 -0
- package/docs/api/repos.md +211 -0
- package/docs/api/research.d.ts +295 -0
- package/docs/api/research.md +534 -0
- package/docs/api/revenue.d.ts +402 -0
- package/docs/api/revenue.md +608 -0
- package/docs/api/revenueAnalytics.d.ts +147 -0
- package/docs/api/revenueAnalytics.md +212 -0
- package/docs/api/revenueLifecycle.d.ts +207 -0
- package/docs/api/revenueLifecycle.md +274 -0
- package/docs/api/revenueRecords.d.ts +372 -0
- package/docs/api/revenueRecords.md +563 -0
- package/docs/api/roles.d.ts +431 -0
- package/docs/api/roles.md +812 -0
- package/docs/api/salesCoach.d.ts +877 -0
- package/docs/api/salesCoach.md +1540 -0
- package/docs/api/sandbox.d.ts +210 -0
- package/docs/api/sandbox.md +380 -0
- package/docs/api/scans.d.ts +104 -0
- package/docs/api/scans.md +136 -0
- package/docs/api/scheduleBuy.d.ts +293 -0
- package/docs/api/scheduleBuy.md +431 -0
- package/docs/api/scraping.d.ts +266 -0
- package/docs/api/scraping.md +383 -0
- package/docs/api/sdrAnalytics.d.ts +138 -0
- package/docs/api/sdrAnalytics.md +246 -0
- package/docs/api/search.d.ts +598 -0
- package/docs/api/search.md +866 -0
- package/docs/api/seo.d.ts +447 -0
- package/docs/api/seo.md +660 -0
- package/docs/api/sequenceLifecycle.d.ts +439 -0
- package/docs/api/sequenceLifecycle.md +513 -0
- package/docs/api/sequences.d.ts +1936 -0
- package/docs/api/sequences.md +3232 -0
- package/docs/api/settings.d.ts +448 -0
- package/docs/api/settings.md +731 -0
- package/docs/api/signals.d.ts +1441 -0
- package/docs/api/signals.md +2526 -0
- package/docs/api/signatures.d.ts +719 -0
- package/docs/api/signatures.md +1247 -0
- package/docs/api/skills.d.ts +230 -0
- package/docs/api/skills.md +466 -0
- package/docs/api/snippet.d.ts +85 -0
- package/docs/api/snippet.md +106 -0
- package/docs/api/socialPublishing.d.ts +824 -0
- package/docs/api/socialPublishing.md +1245 -0
- package/docs/api/studioDocuments.d.ts +244 -0
- package/docs/api/studioDocuments.md +348 -0
- package/docs/api/support.d.ts +90 -0
- package/docs/api/support.md +76 -0
- package/docs/api/suppressions.d.ts +241 -0
- package/docs/api/suppressions.md +343 -0
- package/docs/api/surveys.d.ts +847 -0
- package/docs/api/surveys.md +1223 -0
- package/docs/api/tasks.d.ts +813 -0
- package/docs/api/tasks.md +1344 -0
- package/docs/api/teamMembers.d.ts +668 -0
- package/docs/api/teamMembers.md +1040 -0
- package/docs/api/teams.d.ts +784 -0
- package/docs/api/teams.md +1395 -0
- package/docs/api/usage.d.ts +277 -0
- package/docs/api/usage.md +389 -0
- package/docs/api/visitors.d.ts +690 -0
- package/docs/api/visitors.md +1075 -0
- package/docs/api/voice.d.ts +4661 -0
- package/docs/api/voice.md +7905 -0
- package/docs/api/webAnalytics.d.ts +964 -0
- package/docs/api/webAnalytics.md +1452 -0
- package/docs/api/webChat.d.ts +1704 -0
- package/docs/api/webChat.md +2048 -0
- package/docs/api/webhooks.d.ts +251 -0
- package/docs/api/webhooks.md +386 -0
- package/docs/api/websiteEditor.d.ts +324 -0
- package/docs/api/websiteEditor.md +517 -0
- package/docs/api/work.d.ts +2298 -0
- package/docs/api/work.md +3096 -0
- package/docs/api/workbench.d.ts +2962 -0
- package/docs/api/workbench.md +4884 -0
- package/docs/api/workflows.d.ts +1218 -0
- package/docs/api/workflows.md +2302 -0
- package/docs/sdk-clients.md +4339 -0
- package/package.json +10 -3
|
@@ -0,0 +1,3260 @@
|
|
|
1
|
+
<!-- Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. -->
|
|
2
|
+
|
|
3
|
+
# Operations by REST path
|
|
4
|
+
|
|
5
|
+
Every Developer API route, sorted by path, with the SDK call that reaches it. The base URL is `https://be.graph8.com`; every path below includes the `/api/v1` prefix.
|
|
6
|
+
|
|
7
|
+
| Method | Path | SDK call | Tier |
|
|
8
|
+
|---|---|---|---|
|
|
9
|
+
| GET | `/api/v1/accounts/documents` | [`g8.api.accounts.listAccountDocumentsBatch`](accounts.md#op-listaccountdocumentsbatch) | read |
|
|
10
|
+
| GET | `/api/v1/accounts/enriched` | [`g8.api.accounts.listAccountsEnriched`](accounts.md#op-listaccountsenriched) | read |
|
|
11
|
+
| GET | `/api/v1/accounts/intent-signal` | [`g8.api.accounts.getIntentSignal`](accounts.md#op-getintentsignal) | read |
|
|
12
|
+
| GET | `/api/v1/accounts/revenue-summary` | [`g8.api.accounts.getRevenueSummary`](accounts.md#op-getrevenuesummary) | read |
|
|
13
|
+
| GET | `/api/v1/accounts/trial-dropoff-funnel` | [`g8.api.accounts.getTrialDropoffFunnel`](accounts.md#op-gettrialdropofffunnel) | read |
|
|
14
|
+
| GET | `/api/v1/accounts/trial-dropoff-funnel/step` | [`g8.api.accounts.getTrialDropoffStep`](accounts.md#op-gettrialdropoffstep) | read |
|
|
15
|
+
| GET | `/api/v1/accounts/trial-overview` | [`g8.api.accounts.getTrialOverview`](accounts.md#op-gettrialoverview) | read |
|
|
16
|
+
| GET | `/api/v1/accounts/trial-overview/list` | [`g8.api.accounts.getTrialOverviewList`](accounts.md#op-gettrialoverviewlist) | read |
|
|
17
|
+
| GET | `/api/v1/accounts/{account_id}/adoption-matrix` | [`g8.api.accounts.getAccountAdoptionMatrix`](accounts.md#op-getaccountadoptionmatrix) | read |
|
|
18
|
+
| GET | `/api/v1/accounts/{account_id}/billing` | [`g8.api.accounts.getAccountBilling`](accounts.md#op-getaccountbilling) | read |
|
|
19
|
+
| GET | `/api/v1/accounts/{account_id}/correspondence` | [`g8.api.documents.listAccountCorrespondence`](documents.md#op-listaccountcorrespondence) | read |
|
|
20
|
+
| POST | `/api/v1/accounts/{account_id}/correspondence` | [`g8.api.documents.createAccountCorrespondence`](documents.md#op-createaccountcorrespondence) | write |
|
|
21
|
+
| POST | `/api/v1/accounts/{account_id}/correspondence/import` | [`g8.api.documents.importAccountCorrespondence`](documents.md#op-importaccountcorrespondence) | write |
|
|
22
|
+
| POST | `/api/v1/accounts/{account_id}/correspondence/upload` | [`g8.api.documents.uploadAccountCorrespondence`](documents.md#op-uploadaccountcorrespondence) | write |
|
|
23
|
+
| DELETE | `/api/v1/accounts/{account_id}/correspondence/{correspondence_id}` | [`g8.api.documents.deleteAccountCorrespondence`](documents.md#op-deleteaccountcorrespondence) | destructive |
|
|
24
|
+
| GET | `/api/v1/accounts/{account_id}/deals` | [`g8.api.deals.listAccountDeals`](deals.md#op-listaccountdeals) | read |
|
|
25
|
+
| POST | `/api/v1/accounts/{account_id}/deals` | [`g8.api.deals.createAccountDeal`](deals.md#op-createaccountdeal) | write |
|
|
26
|
+
| POST | `/api/v1/accounts/{account_id}/generate-outreach-plan` | [`g8.api.accounts.generateOutreachPlan`](accounts.md#op-generateoutreachplan) | billable |
|
|
27
|
+
| GET | `/api/v1/accounts/{account_id}/intent-signals` | [`g8.api.accounts.getAccountIntentSignals`](accounts.md#op-getaccountintentsignals) | read |
|
|
28
|
+
| GET | `/api/v1/accounts/{account_id}/security-questionnaires` | [`g8.api.documents.listSecurityQuestionnaires`](documents.md#op-listsecurityquestionnaires) | read |
|
|
29
|
+
| POST | `/api/v1/accounts/{account_id}/security-questionnaires` | [`g8.api.documents.uploadSecurityQuestionnaire`](documents.md#op-uploadsecurityquestionnaire) | billable |
|
|
30
|
+
| DELETE | `/api/v1/accounts/{account_id}/security-questionnaires/{questionnaire_id}` | [`g8.api.documents.deleteSecurityQuestionnaire`](documents.md#op-deletesecurityquestionnaire) | destructive |
|
|
31
|
+
| GET | `/api/v1/accounts/{account_id}/security-questionnaires/{questionnaire_id}` | [`g8.api.documents.getSecurityQuestionnaire`](documents.md#op-getsecurityquestionnaire) | read |
|
|
32
|
+
| PATCH | `/api/v1/accounts/{account_id}/security-questionnaires/{questionnaire_id}` | [`g8.api.documents.updateSecurityQuestionnaire`](documents.md#op-updatesecurityquestionnaire) | write |
|
|
33
|
+
| GET | `/api/v1/accounts/{account_id}/security-questionnaires/{questionnaire_id}/download` | [`g8.api.documents.downloadSecurityQuestionnaire`](documents.md#op-downloadsecurityquestionnaire) | read |
|
|
34
|
+
| PATCH | `/api/v1/accounts/{account_id}/security-questionnaires/{questionnaire_id}/questions/{question_id}` | [`g8.api.documents.updateQuestionnaireAnswer`](documents.md#op-updatequestionnaireanswer) | write |
|
|
35
|
+
| POST | `/api/v1/accounts/{account_id}/security-questionnaires/{questionnaire_id}/questions/{question_id}/approve` | [`g8.api.documents.approveQuestionnaireAnswer`](documents.md#op-approvequestionnaireanswer) | write |
|
|
36
|
+
| POST | `/api/v1/accounts/{account_id}/security-questionnaires/{questionnaire_id}/questions/{question_id}/escalate` | [`g8.api.documents.escalateQuestionnaireQuestion`](documents.md#op-escalatequestionnairequestion) | write |
|
|
37
|
+
| POST | `/api/v1/accounts/{account_id}/security-questionnaires/{questionnaire_id}/questions/{question_id}/mark-skip` | [`g8.api.documents.skipQuestionnaireQuestion`](documents.md#op-skipquestionnairequestion) | write |
|
|
38
|
+
| POST | `/api/v1/accounts/{account_id}/security-questionnaires/{questionnaire_id}/questions/{question_id}/mark-wrong` | [`g8.api.documents.flagQuestionnaireAnswer`](documents.md#op-flagquestionnaireanswer) | write |
|
|
39
|
+
| POST | `/api/v1/accounts/{account_id}/security-questionnaires/{questionnaire_id}/questions/{question_id}/save-to-library` | [`g8.api.documents.saveQuestionnaireAnswerToLibrary`](documents.md#op-savequestionnaireanswertolibrary) | write |
|
|
40
|
+
| GET | `/api/v1/accounts/{account_id}/security-questionnaires/{questionnaire_id}/status` | [`g8.api.documents.getSecurityQuestionnaireStatus`](documents.md#op-getsecurityquestionnairestatus) | read |
|
|
41
|
+
| POST | `/api/v1/accounts/{account_id}/stakeholders/{stakeholder_id}/generate-outreach` | [`g8.api.accounts.generateStakeholderOutreach`](accounts.md#op-generatestakeholderoutreach) | billable |
|
|
42
|
+
| POST | `/api/v1/accounts/{account_id}/trial-insight` | [`g8.api.accounts.getTrialInsight`](accounts.md#op-gettrialinsight) | write |
|
|
43
|
+
| GET | `/api/v1/accounts/{account_id}/trial-journey` | [`g8.api.accounts.getAccountTrialJourney`](accounts.md#op-getaccounttrialjourney) | read |
|
|
44
|
+
| GET | `/api/v1/accounts/{mashup_company_id}/contacts` | [`g8.api.accounts.getAccountCompanyContacts`](accounts.md#op-getaccountcompanycontacts) | read |
|
|
45
|
+
| GET | `/api/v1/activities` | [`g8.api.gtmContext.listActivities`](gtmContext.md#op-listactivities) | read |
|
|
46
|
+
| GET | `/api/v1/activities/metrics/summary` | [`g8.api.revenueRecords.getActivityMetrics`](revenueRecords.md#op-getactivitymetrics) | read |
|
|
47
|
+
| GET | `/api/v1/activities/{activity_id}` | [`g8.api.revenueRecords.getActivity`](revenueRecords.md#op-getactivity) | read |
|
|
48
|
+
| GET | `/api/v1/activity-feed` | [`g8.api.contacts.getActivityFeed`](contacts.md#op-getactivityfeed) | read |
|
|
49
|
+
| GET | `/api/v1/ad-campaigns` | [`g8.api.adCampaigns.listAdCampaigns`](adCampaigns.md#op-listadcampaigns) | read |
|
|
50
|
+
| POST | `/api/v1/ad-campaigns/images` | [`g8.api.adCampaigns.uploadAdImage`](adCampaigns.md#op-uploadadimage) | external |
|
|
51
|
+
| GET | `/api/v1/ad-campaigns/metrics` | [`g8.api.adCampaigns.getPerCampaignMetrics`](adCampaigns.md#op-getpercampaignmetrics) | read |
|
|
52
|
+
| POST | `/api/v1/ad-campaigns/status-refresh` | [`g8.api.adCampaigns.refreshAllCampaignStatuses`](adCampaigns.md#op-refreshallcampaignstatuses) | external |
|
|
53
|
+
| DELETE | `/api/v1/ad-campaigns/{campaign_id}` | [`g8.api.adCampaigns.deleteAdCampaign`](adCampaigns.md#op-deleteadcampaign) | destructive |
|
|
54
|
+
| GET | `/api/v1/ad-campaigns/{campaign_id}` | [`g8.api.adCampaigns.getAdCampaign`](adCampaigns.md#op-getadcampaign) | read |
|
|
55
|
+
| PUT | `/api/v1/ad-campaigns/{campaign_id}` | [`g8.api.adCampaigns.updateAdCampaign`](adCampaigns.md#op-updateadcampaign) | external |
|
|
56
|
+
| GET | `/api/v1/ad-campaigns/{campaign_id}/ads` | [`g8.api.adCampaigns.listCampaignAds`](adCampaigns.md#op-listcampaignads) | read |
|
|
57
|
+
| POST | `/api/v1/ad-campaigns/{campaign_id}/ads` | [`g8.api.adCampaigns.createCampaignAd`](adCampaigns.md#op-createcampaignad) | external |
|
|
58
|
+
| POST | `/api/v1/ad-campaigns/{campaign_id}/ads/batch` | [`g8.api.adCampaigns.createCampaignAdsBatch`](adCampaigns.md#op-createcampaignadsbatch) | external |
|
|
59
|
+
| DELETE | `/api/v1/ad-campaigns/{campaign_id}/ads/{ad_id}` | [`g8.api.adCampaigns.archiveCampaignAd`](adCampaigns.md#op-archivecampaignad) | destructive |
|
|
60
|
+
| GET | `/api/v1/ad-campaigns/{campaign_id}/ads/{ad_id}` | [`g8.api.adCampaigns.getCampaignAd`](adCampaigns.md#op-getcampaignad) | read |
|
|
61
|
+
| PATCH | `/api/v1/ad-campaigns/{campaign_id}/ads/{ad_id}` | [`g8.api.adCampaigns.updateCampaignAd`](adCampaigns.md#op-updatecampaignad) | external |
|
|
62
|
+
| POST | `/api/v1/ad-campaigns/{campaign_id}/ads/{ad_id}/status` | [`g8.api.adCampaigns.setCampaignAdStatus`](adCampaigns.md#op-setcampaignadstatus) | external |
|
|
63
|
+
| POST | `/api/v1/ad-campaigns/{campaign_id}/edit-preview` | [`g8.api.adCampaigns.previewAdCampaignEdit`](adCampaigns.md#op-previewadcampaignedit) | external |
|
|
64
|
+
| GET | `/api/v1/ad-campaigns/{campaign_id}/editable` | [`g8.api.adCampaigns.getCampaignEditableFields`](adCampaigns.md#op-getcampaigneditablefields) | read |
|
|
65
|
+
| POST | `/api/v1/ad-campaigns/{campaign_id}/retry` | [`g8.api.adCampaigns.retryCampaignLaunch`](adCampaigns.md#op-retrycampaignlaunch) | external |
|
|
66
|
+
| POST | `/api/v1/ad-campaigns/{campaign_id}/status-refresh` | [`g8.api.adCampaigns.refreshCampaignStatus`](adCampaigns.md#op-refreshcampaignstatus) | external |
|
|
67
|
+
| GET | `/api/v1/ad-creatives` | [`g8.api.adCreatives.listAdCreatives`](adCreatives.md#op-listadcreatives) | read |
|
|
68
|
+
| POST | `/api/v1/ad-creatives` | [`g8.api.adCreatives.createAdCreative`](adCreatives.md#op-createadcreative) | billable |
|
|
69
|
+
| POST | `/api/v1/ad-creatives/batch` | [`g8.api.adCreatives.createAdCreativeSet`](adCreatives.md#op-createadcreativeset) | billable |
|
|
70
|
+
| POST | `/api/v1/ad-creatives/concepts` | [`g8.api.adCreatives.generateAdConcepts`](adCreatives.md#op-generateadconcepts) | billable |
|
|
71
|
+
| GET | `/api/v1/ad-creatives/specs` | [`g8.api.adCreatives.getAdCreativeSpecs`](adCreatives.md#op-getadcreativespecs) | read |
|
|
72
|
+
| POST | `/api/v1/ad-creatives/video` | [`g8.api.adCreatives.createVideoAdCreative`](adCreatives.md#op-createvideoadcreative) | write |
|
|
73
|
+
| GET | `/api/v1/ad-creatives/video-templates` | [`g8.api.adCreatives.listVideoAdTemplates`](adCreatives.md#op-listvideoadtemplates) | read |
|
|
74
|
+
| GET | `/api/v1/ad-creatives/video/clips` | [`g8.api.adCreatives.listVideoClips`](adCreatives.md#op-listvideoclips) | read |
|
|
75
|
+
| POST | `/api/v1/ad-creatives/video/clips` | [`g8.api.adCreatives.generateVideoClip`](adCreatives.md#op-generatevideoclip) | billable |
|
|
76
|
+
| POST | `/api/v1/ad-creatives/video/clips/prompt-enhance` | [`g8.api.adCreatives.enhanceVideoClipPrompt`](adCreatives.md#op-enhancevideoclipprompt) | billable |
|
|
77
|
+
| DELETE | `/api/v1/ad-creatives/video/clips/{clip_id}` | [`g8.api.adCreatives.discardVideoClip`](adCreatives.md#op-discardvideoclip) | destructive |
|
|
78
|
+
| GET | `/api/v1/ad-creatives/video/clips/{clip_id}` | [`g8.api.adCreatives.getVideoClip`](adCreatives.md#op-getvideoclip) | read |
|
|
79
|
+
| POST | `/api/v1/ad-creatives/video/clips/{clip_id}/continue` | [`g8.api.adCreatives.continueVideoClip`](adCreatives.md#op-continuevideoclip) | billable |
|
|
80
|
+
| POST | `/api/v1/ad-creatives/video/clips/{clip_id}/extend` | [`g8.api.adCreatives.extendVideoClip`](adCreatives.md#op-extendvideoclip) | billable |
|
|
81
|
+
| POST | `/api/v1/ad-creatives/video/clips/{clip_id}/regenerate` | [`g8.api.adCreatives.regenerateVideoClip`](adCreatives.md#op-regeneratevideoclip) | billable |
|
|
82
|
+
| DELETE | `/api/v1/ad-creatives/{creative_id}` | [`g8.api.adCreatives.deleteAdCreative`](adCreatives.md#op-deleteadcreative) | destructive |
|
|
83
|
+
| GET | `/api/v1/ad-creatives/{creative_id}` | [`g8.api.adCreatives.getAdCreative`](adCreatives.md#op-getadcreative) | read |
|
|
84
|
+
| PATCH | `/api/v1/ad-creatives/{creative_id}` | [`g8.api.adCreatives.updateAdCreative`](adCreatives.md#op-updateadcreative) | write |
|
|
85
|
+
| POST | `/api/v1/ad-creatives/{creative_id}/ai-review` | [`g8.api.adCreatives.reviewAdCreative`](adCreatives.md#op-reviewadcreative) | billable |
|
|
86
|
+
| POST | `/api/v1/ad-creatives/{creative_id}/ai-review/apply` | [`g8.api.adCreatives.applyAdCreativeReviewFindings`](adCreatives.md#op-applyadcreativereviewfindings) | write |
|
|
87
|
+
| POST | `/api/v1/ad-creatives/{creative_id}/chat-edit` | [`g8.api.adCreatives.chatEditAdCreative`](adCreatives.md#op-chateditadcreative) | billable |
|
|
88
|
+
| GET | `/api/v1/ad-creatives/{creative_id}/conversation` | [`g8.api.adCreatives.getAdCreativeConversation`](adCreatives.md#op-getadcreativeconversation) | read |
|
|
89
|
+
| POST | `/api/v1/ad-creatives/{creative_id}/image-edit-at-point` | [`g8.api.adCreatives.editAdCreativeImageAtPoint`](adCreatives.md#op-editadcreativeimageatpoint) | billable |
|
|
90
|
+
| POST | `/api/v1/ad-creatives/{creative_id}/image-element` | [`g8.api.adCreatives.editAdCreativeImageElement`](adCreatives.md#op-editadcreativeimageelement) | write |
|
|
91
|
+
| GET | `/api/v1/ad-creatives/{creative_id}/image-elements` | [`g8.api.adCreatives.listAdCreativeImageElements`](adCreatives.md#op-listadcreativeimageelements) | read |
|
|
92
|
+
| POST | `/api/v1/ad-creatives/{creative_id}/move-to-draft` | [`g8.api.adCreatives.moveAdCreativeToDraft`](adCreatives.md#op-moveadcreativetodraft) | write |
|
|
93
|
+
| POST | `/api/v1/ad-creatives/{creative_id}/move-to-gallery` | [`g8.api.adCreatives.moveAdCreativeToGallery`](adCreatives.md#op-moveadcreativetogallery) | write |
|
|
94
|
+
| POST | `/api/v1/ad-creatives/{creative_id}/persona-lens` | [`g8.api.adCreatives.readAdCreativeThroughPersona`](adCreatives.md#op-readadcreativethroughpersona) | billable |
|
|
95
|
+
| POST | `/api/v1/ad-creatives/{creative_id}/regenerate-copy` | [`g8.api.adCreatives.regenerateAdCreativeCopy`](adCreatives.md#op-regenerateadcreativecopy) | billable |
|
|
96
|
+
| POST | `/api/v1/ad-creatives/{creative_id}/regenerate-image` | [`g8.api.adCreatives.regenerateAdCreativeImage`](adCreatives.md#op-regenerateadcreativeimage) | billable |
|
|
97
|
+
| POST | `/api/v1/ad-creatives/{creative_id}/reskin` | [`g8.api.adCreatives.reskinAdCreative`](adCreatives.md#op-reskinadcreative) | write |
|
|
98
|
+
| POST | `/api/v1/ad-creatives/{creative_id}/restore-revision` | [`g8.api.adCreatives.restoreAdCreativeRevision`](adCreatives.md#op-restoreadcreativerevision) | write |
|
|
99
|
+
| POST | `/api/v1/ad-creatives/{creative_id}/retry` | [`g8.api.adCreatives.retryAdCreativeGeneration`](adCreatives.md#op-retryadcreativegeneration) | billable |
|
|
100
|
+
| GET | `/api/v1/ad-creatives/{creative_id}/revisions` | [`g8.api.adCreatives.listAdCreativeRevisions`](adCreatives.md#op-listadcreativerevisions) | read |
|
|
101
|
+
| POST | `/api/v1/ad-creatives/{creative_id}/rewrite-field` | [`g8.api.adCreatives.rewriteAdCreativeField`](adCreatives.md#op-rewriteadcreativefield) | billable |
|
|
102
|
+
| POST | `/api/v1/ad-creatives/{creative_id}/save-as-template` | [`g8.api.adCreatives.saveAdCreativeAsTemplate`](adCreatives.md#op-saveadcreativeastemplate) | write |
|
|
103
|
+
| POST | `/api/v1/ad-creatives/{creative_id}/set-image` | [`g8.api.adCreatives.setAdCreativeImage`](adCreatives.md#op-setadcreativeimage) | write |
|
|
104
|
+
| POST | `/api/v1/ad-creatives/{creative_id}/set-image-focus` | [`g8.api.adCreatives.setAdCreativeImageFocus`](adCreatives.md#op-setadcreativeimagefocus) | write |
|
|
105
|
+
| POST | `/api/v1/ad-creatives/{creative_id}/size-set` | [`g8.api.adCreatives.createAdCreativeSizeSet`](adCreatives.md#op-createadcreativesizeset) | billable |
|
|
106
|
+
| GET | `/api/v1/ad-creatives/{creative_id}/status` | [`g8.api.adCreatives.getAdCreativeStatus`](adCreatives.md#op-getadcreativestatus) | read |
|
|
107
|
+
| GET | `/api/v1/agency/clients` | [`g8.api.agency.listAgencyClients`](agency.md#op-listagencyclients) or `g8.agency.clients()` | read |
|
|
108
|
+
| GET | `/api/v1/agency/me` | [`g8.api.agency.getAgencyMe`](agency.md#op-getagencyme) or `g8.agency.me()` | read |
|
|
109
|
+
| GET | `/api/v1/agency/reports/clients/{org_id}` | [`g8.api.agency.getClientDetail`](agency.md#op-getclientdetail) | read |
|
|
110
|
+
| GET | `/api/v1/agency/reports/clients/{org_id}/deliverability` | [`g8.api.agency.getClientDeliverability`](agency.md#op-getclientdeliverability) | read |
|
|
111
|
+
| GET | `/api/v1/agency/reports/clients/{org_id}/sequences` | [`g8.api.agency.getClientSequences`](agency.md#op-getclientsequences) | read |
|
|
112
|
+
| GET | `/api/v1/agency/reports/comparison` | [`g8.api.agency.getClientComparison`](agency.md#op-getclientcomparison) | read |
|
|
113
|
+
| GET | `/api/v1/agency/reports/deliverability` | [`g8.api.agency.getCrossOrgDeliverability`](agency.md#op-getcrossorgdeliverability) | read |
|
|
114
|
+
| GET | `/api/v1/agency/reports/dialer/dashboard` | [`g8.api.agency.getAgencyDialerDashboard`](agency.md#op-getagencydialerdashboard) | read |
|
|
115
|
+
| POST | `/api/v1/agency/reports/dialer/grading/search` | [`g8.api.agency.searchAgencyGradedCalls`](agency.md#op-searchagencygradedcalls) | read |
|
|
116
|
+
| GET | `/api/v1/agency/reports/dialer/leaderboard` | [`g8.api.agency.getAgencyDialerLeaderboard`](agency.md#op-getagencydialerleaderboard) | read |
|
|
117
|
+
| GET | `/api/v1/agency/reports/dialer/quality-leaderboard` | [`g8.api.agency.getAgencyDialerQualityLeaderboard`](agency.md#op-getagencydialerqualityleaderboard) | read |
|
|
118
|
+
| GET | `/api/v1/agency/reports/health` | [`g8.api.agency.getAccountHealth`](agency.md#op-getaccounthealth) | read |
|
|
119
|
+
| GET | `/api/v1/agency/reports/leaderboard` | [`g8.api.agency.getAgencyLeaderboard`](agency.md#op-getagencyleaderboard) | read |
|
|
120
|
+
| GET | `/api/v1/agency/reports/meetings` | [`g8.api.agency.getMeetingsLeaderboard`](agency.md#op-getmeetingsleaderboard) | read |
|
|
121
|
+
| GET | `/api/v1/agency/reports/meetings/by-channel` | [`g8.api.agency.getMeetingsByChannel`](agency.md#op-getmeetingsbychannel) | read |
|
|
122
|
+
| GET | `/api/v1/agency/reports/meetings/count` | [`g8.api.agency.getMeetingsCountForChannel`](agency.md#op-getmeetingscountforchannel) | read |
|
|
123
|
+
| GET | `/api/v1/agency/reports/sdr-leaderboard` | [`g8.api.agency.getAgencySdrLeaderboard`](agency.md#op-getagencysdrleaderboard) | read |
|
|
124
|
+
| GET | `/api/v1/agency/reports/sequence-leaderboard` | [`g8.api.agency.getAgencySequenceLeaderboard`](agency.md#op-getagencysequenceleaderboard) | read |
|
|
125
|
+
| GET | `/api/v1/agency/reports/summary` | [`g8.api.agency.getConsolidatedSummary`](agency.md#op-getconsolidatedsummary) | read |
|
|
126
|
+
| GET | `/api/v1/agency/reports/trends` | [`g8.api.agency.getAgencyTrends`](agency.md#op-getagencytrends) | read |
|
|
127
|
+
| GET | `/api/v1/agency/reports/voice-ai/agent-leaderboard` | [`g8.api.agency.getVoiceAiAgentLeaderboard`](agency.md#op-getvoiceaiagentleaderboard) | read |
|
|
128
|
+
| GET | `/api/v1/agency/reports/voice-ai/dashboard` | [`g8.api.agency.getVoiceAiDashboard`](agency.md#op-getvoiceaidashboard) | read |
|
|
129
|
+
| POST | `/api/v1/agency/reports/voice-ai/grading/search` | [`g8.api.agency.searchVoiceAiGradedCalls`](agency.md#op-searchvoiceaigradedcalls) | read |
|
|
130
|
+
| GET | `/api/v1/agency/reports/voice-ai/quality-leaderboard` | [`g8.api.agency.getVoiceAiQualityLeaderboard`](agency.md#op-getvoiceaiqualityleaderboard) | read |
|
|
131
|
+
| GET | `/api/v1/agent/approvals` | [`g8.api.agent.listAgentApprovals`](agent.md#op-listagentapprovals) | read |
|
|
132
|
+
| GET | `/api/v1/agent/approvals/history` | [`g8.api.agent.listAgentApprovalHistory`](agent.md#op-listagentapprovalhistory) | read |
|
|
133
|
+
| POST | `/api/v1/agent/approvals/{approval_id}/decide` | [`g8.api.agent.decideAgentApproval`](agent.md#op-decideagentapproval) | write |
|
|
134
|
+
| GET | `/api/v1/agent/approvals/{approval_id}/receipts` | [`g8.api.agent.getAgentApprovalReceipts`](agent.md#op-getagentapprovalreceipts) | read |
|
|
135
|
+
| POST | `/api/v1/agent/approvals/{approval_id}/request-changes` | [`g8.api.agents.requestAgentApprovalChanges`](agents.md#op-requestagentapprovalchanges) | write |
|
|
136
|
+
| POST | `/api/v1/agent/chat` | [`g8.api.agents.postAgentChat`](agents.md#op-postagentchat) | billable |
|
|
137
|
+
| GET | `/api/v1/agent/evidence/pushback` | [`g8.api.agents.getAgentPushbackEvidence`](agents.md#op-getagentpushbackevidence) | read |
|
|
138
|
+
| GET | `/api/v1/agent/memory` | [`g8.api.agents.getAgentMemory`](agents.md#op-getagentmemory) | read |
|
|
139
|
+
| POST | `/api/v1/agent/mention-search` | [`g8.api.agents.searchAgentMentions`](agents.md#op-searchagentmentions) | read |
|
|
140
|
+
| POST | `/api/v1/agent/onboarding/attribution` | [`g8.api.agents.captureAgentSignupAttribution`](agents.md#op-captureagentsignupattribution) | write |
|
|
141
|
+
| POST | `/api/v1/agent/onboarding/catchup` | [`g8.api.agents.postAgentOnboardingCatchup`](agents.md#op-postagentonboardingcatchup) | write |
|
|
142
|
+
| GET | `/api/v1/agent/onboarding/discovery` | [`g8.api.agents.getAgentDiscovery`](agents.md#op-getagentdiscovery) | read |
|
|
143
|
+
| POST | `/api/v1/agent/onboarding/discovery/answer` | [`g8.api.agents.answerAgentDiscovery`](agents.md#op-answeragentdiscovery) | write |
|
|
144
|
+
| GET | `/api/v1/agent/onboarding/discovery/campaign-brief` | [`g8.api.agents.getAgentDiscoveryCampaignBrief`](agents.md#op-getagentdiscoverycampaignbrief) | read |
|
|
145
|
+
| POST | `/api/v1/agent/onboarding/discovery/open` | [`g8.api.agents.openAgentDiscovery`](agents.md#op-openagentdiscovery) | write |
|
|
146
|
+
| POST | `/api/v1/agent/onboarding/discovery/project` | [`g8.api.agents.projectAgentDiscovery`](agents.md#op-projectagentdiscovery) | write |
|
|
147
|
+
| POST | `/api/v1/agent/onboarding/discovery/ratify` | [`g8.api.agents.ratifyAgentDiscovery`](agents.md#op-ratifyagentdiscovery) | write |
|
|
148
|
+
| GET | `/api/v1/agent/onboarding/discovery/report` | [`g8.api.agents.getAgentDiscoveryReport`](agents.md#op-getagentdiscoveryreport) | read |
|
|
149
|
+
| POST | `/api/v1/agent/onboarding/discovery/signals` | [`g8.api.agents.setupAgentDiscoverySignals`](agents.md#op-setupagentdiscoverysignals) | write |
|
|
150
|
+
| POST | `/api/v1/agent/onboarding/discovery/turn` | [`g8.api.agents.takeAgentDiscoveryTurn`](agents.md#op-takeagentdiscoveryturn) | billable |
|
|
151
|
+
| POST | `/api/v1/agent/onboarding/domain-response` | [`g8.api.agents.submitAgentDomainResponse`](agents.md#op-submitagentdomainresponse) | write |
|
|
152
|
+
| POST | `/api/v1/agent/onboarding/entry-point` | [`g8.api.agents.captureAgentEntryPoint`](agents.md#op-captureagententrypoint) | write |
|
|
153
|
+
| GET | `/api/v1/agent/operators` | [`g8.api.agents.listAgentOperators`](agents.md#op-listagentoperators) | read |
|
|
154
|
+
| GET | `/api/v1/agent/operators/approvals/sources` | [`g8.api.agents.listAgentOperatorApprovalSources`](agents.md#op-listagentoperatorapprovalsources) | read |
|
|
155
|
+
| GET | `/api/v1/agent/operators/approvals/{task_id}/operator` | [`g8.api.agents.getAgentOperatorForApprovalTask`](agents.md#op-getagentoperatorforapprovaltask) | read |
|
|
156
|
+
| GET | `/api/v1/agent/operators/operating-model` | [`g8.api.agents.getAgentOperatingModel`](agents.md#op-getagentoperatingmodel) | read |
|
|
157
|
+
| PUT | `/api/v1/agent/operators/operating-model` | [`g8.api.agents.putAgentOperatingModel`](agents.md#op-putagentoperatingmodel) | write |
|
|
158
|
+
| GET | `/api/v1/agent/operators/summary` | [`g8.api.agents.getAgentOperatorsSummary`](agents.md#op-getagentoperatorssummary) | read |
|
|
159
|
+
| GET | `/api/v1/agent/operators/{operator}/actions` | [`g8.api.agents.listAgentOperatorActions`](agents.md#op-listagentoperatoractions) | read |
|
|
160
|
+
| GET | `/api/v1/agent/operators/{operator}/activity` | [`g8.api.agents.listAgentOperatorActivity`](agents.md#op-listagentoperatoractivity) | read |
|
|
161
|
+
| GET | `/api/v1/agent/operators/{operator}/activity/{task_id}/records` | [`g8.api.agents.listAgentOperatorActivityRecords`](agents.md#op-listagentoperatoractivityrecords) | read |
|
|
162
|
+
| POST | `/api/v1/agent/operators/{operator}/approvals/{task_id}/decide` | [`g8.api.agents.decideAgentOperatorApproval`](agents.md#op-decideagentoperatorapproval) | billable |
|
|
163
|
+
| GET | `/api/v1/agent/operators/{operator}/catalog` | [`g8.api.agents.getAgentOperatorCatalog`](agents.md#op-getagentoperatorcatalog) | read |
|
|
164
|
+
| GET | `/api/v1/agent/operators/{operator}/collections` | [`g8.api.agents.listAgentOperatorCollections`](agents.md#op-listagentoperatorcollections) | read |
|
|
165
|
+
| PUT | `/api/v1/agent/operators/{operator}/enabled` | [`g8.api.agents.setAgentOperatorEnabled`](agents.md#op-setagentoperatorenabled) | billable |
|
|
166
|
+
| GET | `/api/v1/agent/operators/{operator}/feedback/summary` | [`g8.api.agents.getAgentOperatorFeedbackSummary`](agents.md#op-getagentoperatorfeedbacksummary) | read |
|
|
167
|
+
| GET | `/api/v1/agent/operators/{operator}/findings` | [`g8.api.agents.listAgentOperatorFindings`](agents.md#op-listagentoperatorfindings) | read |
|
|
168
|
+
| GET | `/api/v1/agent/operators/{operator}/health` | [`g8.api.agents.getAgentOperatorHealth`](agents.md#op-getagentoperatorhealth) | read |
|
|
169
|
+
| GET | `/api/v1/agent/operators/{operator}/recipient` | [`g8.api.agents.getAgentOperatorRecipient`](agents.md#op-getagentoperatorrecipient) | read |
|
|
170
|
+
| PUT | `/api/v1/agent/operators/{operator}/recipient` | [`g8.api.agents.setAgentOperatorRecipient`](agents.md#op-setagentoperatorrecipient) | write |
|
|
171
|
+
| GET | `/api/v1/agent/operators/{operator}/scorecard` | [`g8.api.agents.getAgentOperatorScorecard`](agents.md#op-getagentoperatorscorecard) | read |
|
|
172
|
+
| GET | `/api/v1/agent/operators/{operator}/skills` | [`g8.api.agents.listAgentOperatorSkills`](agents.md#op-listagentoperatorskills) | read |
|
|
173
|
+
| PUT | `/api/v1/agent/operators/{operator}/skills/{skill_key}` | [`g8.api.agents.setAgentOperatorTrustDial`](agents.md#op-setagentoperatortrustdial) | billable |
|
|
174
|
+
| GET | `/api/v1/agent/operators/{operator}/status` | [`g8.api.agents.getAgentOperatorStatus`](agents.md#op-getagentoperatorstatus) | read |
|
|
175
|
+
| GET | `/api/v1/agent/oversight` | [`g8.api.agents.getAgentOversight`](agents.md#op-getagentoversight) | read |
|
|
176
|
+
| GET | `/api/v1/agent/proactive-opener` | [`g8.api.agents.getAgentProactiveOpener`](agents.md#op-getagentproactiveopener) | read |
|
|
177
|
+
| GET | `/api/v1/agent/runs` | [`g8.api.agent.listAgentRuns`](agent.md#op-listagentruns) | read |
|
|
178
|
+
| POST | `/api/v1/agent/runs` | [`g8.api.agent.createAgentRun`](agent.md#op-createagentrun) | write |
|
|
179
|
+
| GET | `/api/v1/agent/runs/{run_id}` | [`g8.api.agent.getAgentRun`](agent.md#op-getagentrun) | read |
|
|
180
|
+
| POST | `/api/v1/agent/runs/{run_id}/cancel` | [`g8.api.agent.cancelAgentRun`](agent.md#op-cancelagentrun) | destructive |
|
|
181
|
+
| GET | `/api/v1/agent/sessions` | [`g8.api.agents.listAgentSessions`](agents.md#op-listagentsessions) | read |
|
|
182
|
+
| POST | `/api/v1/agent/sessions` | [`g8.api.agents.createAgentSession`](agents.md#op-createagentsession) | write |
|
|
183
|
+
| GET | `/api/v1/agent/sessions/voice/capability` | [`g8.api.agents.getAgentVoiceCapability`](agents.md#op-getagentvoicecapability) | read |
|
|
184
|
+
| POST | `/api/v1/agent/sessions/voice/draft` | [`g8.api.agents.createAgentVoiceDraft`](agents.md#op-createagentvoicedraft) | write |
|
|
185
|
+
| DELETE | `/api/v1/agent/sessions/{session_id}` | [`g8.api.agents.deleteAgentSession`](agents.md#op-deleteagentsession) | destructive |
|
|
186
|
+
| GET | `/api/v1/agent/sessions/{session_id}` | [`g8.api.agents.getAgentSession`](agents.md#op-getagentsession) | read |
|
|
187
|
+
| PATCH | `/api/v1/agent/sessions/{session_id}` | [`g8.api.agents.updateAgentSession`](agents.md#op-updateagentsession) | write |
|
|
188
|
+
| POST | `/api/v1/agent/sessions/{session_id}/cards/{card_id}/confirm` | [`g8.api.agents.confirmAgentSessionCard`](agents.md#op-confirmagentsessioncard) | write |
|
|
189
|
+
| POST | `/api/v1/agent/sessions/{session_id}/messages` | [`g8.api.agents.postAgentSessionMessage`](agents.md#op-postagentsessionmessage) | write |
|
|
190
|
+
| POST | `/api/v1/agent/sessions/{session_id}/pin` | [`g8.api.agents.pinAgentSession`](agents.md#op-pinagentsession) | write |
|
|
191
|
+
| PUT | `/api/v1/agent/sessions/{session_id}/read` | [`g8.api.agents.markAgentSessionRead`](agents.md#op-markagentsessionread) | write |
|
|
192
|
+
| POST | `/api/v1/agent/sessions/{session_id}/rename` | [`g8.api.agents.renameAgentSession`](agents.md#op-renameagentsession) | write |
|
|
193
|
+
| GET | `/api/v1/agent/sessions/{session_id}/state` | [`g8.api.agents.getAgentSessionState`](agents.md#op-getagentsessionstate) | read |
|
|
194
|
+
| GET | `/api/v1/agent/sessions/{session_id}/voice` | [`g8.api.agents.getAgentSessionVoiceCapability`](agents.md#op-getagentsessionvoicecapability) | read |
|
|
195
|
+
| POST | `/api/v1/agent/sessions/{session_id}/voice` | [`g8.api.agents.startAgentSessionVoice`](agents.md#op-startagentsessionvoice) | billable |
|
|
196
|
+
| POST | `/api/v1/agent/sessions/{session_id}/voice/quote` | [`g8.api.agents.quoteAgentSessionVoice`](agents.md#op-quoteagentsessionvoice) | read |
|
|
197
|
+
| DELETE | `/api/v1/agent/sessions/{session_id}/voice/{voice_id}` | [`g8.api.agents.endAgentSessionVoice`](agents.md#op-endagentsessionvoice) | destructive |
|
|
198
|
+
| GET | `/api/v1/agent/specialists` | [`g8.api.agents.listAgentSpecialists`](agents.md#op-listagentspecialists) | read |
|
|
199
|
+
| GET | `/api/v1/agent/work-items` | [`g8.api.agents.listAgentWorkItems`](agents.md#op-listagentworkitems) | read |
|
|
200
|
+
| POST | `/api/v1/agent/work-items` | [`g8.api.agents.createAgentWorkItem`](agents.md#op-createagentworkitem) | billable |
|
|
201
|
+
| POST | `/api/v1/agent/work-items/{work_item_id}/cancel` | [`g8.api.agents.cancelAgentWorkItem`](agents.md#op-cancelagentworkitem) | destructive |
|
|
202
|
+
| POST | `/api/v1/agent/work-items/{work_item_id}/steer` | [`g8.api.agents.steerAgentWorkItem`](agents.md#op-steeragentworkitem) | write |
|
|
203
|
+
| GET | `/api/v1/analytics/acquisition/campaigns` | [`g8.api.webAnalytics.getAcquisitionCampaigns`](webAnalytics.md#op-getacquisitioncampaigns) | read |
|
|
204
|
+
| GET | `/api/v1/analytics/acquisition/channels` | [`g8.api.webAnalytics.getAcquisitionChannels`](webAnalytics.md#op-getacquisitionchannels) | read |
|
|
205
|
+
| GET | `/api/v1/analytics/acquisition/channels/trend` | [`g8.api.webAnalytics.getAcquisitionChannelsTrend`](webAnalytics.md#op-getacquisitionchannelstrend) | read |
|
|
206
|
+
| GET | `/api/v1/analytics/acquisition/referrals` | [`g8.api.webAnalytics.getAcquisitionReferrals`](webAnalytics.md#op-getacquisitionreferrals) | read |
|
|
207
|
+
| GET | `/api/v1/analytics/acquisition/search` | [`g8.api.webAnalytics.getAcquisitionSearch`](webAnalytics.md#op-getacquisitionsearch) | read |
|
|
208
|
+
| GET | `/api/v1/analytics/acquisition/social` | [`g8.api.webAnalytics.getAcquisitionSocial`](webAnalytics.md#op-getacquisitionsocial) | read |
|
|
209
|
+
| GET | `/api/v1/analytics/acquisition/sources` | [`g8.api.webAnalytics.getAcquisitionSources`](webAnalytics.md#op-getacquisitionsources) | read |
|
|
210
|
+
| GET | `/api/v1/analytics/attribution/acquisition-breakdown` | [`g8.api.revenueAnalytics.getAcquisitionBreakdown`](revenueAnalytics.md#op-getacquisitionbreakdown) | read |
|
|
211
|
+
| GET | `/api/v1/analytics/attribution/sender-performance` | [`g8.api.revenueAnalytics.getSenderPerformance`](revenueAnalytics.md#op-getsenderperformance) | read |
|
|
212
|
+
| GET | `/api/v1/analytics/audience/behavior` | [`g8.api.webAnalytics.getAudienceBehavior`](webAnalytics.md#op-getaudiencebehavior) | read |
|
|
213
|
+
| GET | `/api/v1/analytics/audience/demographics` | [`g8.api.webAnalytics.getAudienceDemographics`](webAnalytics.md#op-getaudiencedemographics) | read |
|
|
214
|
+
| GET | `/api/v1/analytics/audience/geo` | [`g8.api.webAnalytics.getGeoCountries`](webAnalytics.md#op-getgeocountries) | read |
|
|
215
|
+
| GET | `/api/v1/analytics/audience/geo/cities` | [`g8.api.webAnalytics.getGeoCities`](webAnalytics.md#op-getgeocities) | read |
|
|
216
|
+
| GET | `/api/v1/analytics/audience/languages` | [`g8.api.webAnalytics.getAudienceLanguages`](webAnalytics.md#op-getaudiencelanguages) | read |
|
|
217
|
+
| GET | `/api/v1/analytics/audience/overview` | [`g8.api.webAnalytics.getAudienceOverview`](webAnalytics.md#op-getaudienceoverview) | read |
|
|
218
|
+
| GET | `/api/v1/analytics/audience/technology` | [`g8.api.webAnalytics.getTechnologyOverview`](webAnalytics.md#op-gettechnologyoverview) | read |
|
|
219
|
+
| GET | `/api/v1/analytics/audience/trend` | [`g8.api.webAnalytics.getAudienceTrend`](webAnalytics.md#op-getaudiencetrend) | read |
|
|
220
|
+
| GET | `/api/v1/analytics/behavior/events` | [`g8.api.webAnalytics.getEvents`](webAnalytics.md#op-getevents) | read |
|
|
221
|
+
| GET | `/api/v1/analytics/behavior/exit-pages` | [`g8.api.webAnalytics.getExitPages`](webAnalytics.md#op-getexitpages) | read |
|
|
222
|
+
| GET | `/api/v1/analytics/behavior/landing-pages` | [`g8.api.webAnalytics.getLandingPages`](webAnalytics.md#op-getlandingpages) | read |
|
|
223
|
+
| GET | `/api/v1/analytics/behavior/page-metrics` | [`g8.api.webAnalytics.getPageMetrics`](webAnalytics.md#op-getpagemetrics) | read |
|
|
224
|
+
| GET | `/api/v1/analytics/behavior/pages` | [`g8.api.webAnalytics.getTopPages`](webAnalytics.md#op-gettoppages) | read |
|
|
225
|
+
| GET | `/api/v1/analytics/campaign-visitors` | [`g8.api.analytics.getCampaignVisitors`](analytics.md#op-getcampaignvisitors) | read |
|
|
226
|
+
| GET | `/api/v1/analytics/conversions/forms` | [`g8.api.webAnalytics.getForms`](webAnalytics.md#op-getforms) | read |
|
|
227
|
+
| GET | `/api/v1/analytics/conversions/forms/analysis` | [`g8.api.webAnalytics.getFormAnalysis`](webAnalytics.md#op-getformanalysis) | read |
|
|
228
|
+
| GET | `/api/v1/analytics/conversions/forms/trend` | [`g8.api.webAnalytics.getFormsTrend`](webAnalytics.md#op-getformstrend) | read |
|
|
229
|
+
| GET | `/api/v1/analytics/conversions/funnel` | [`g8.api.webAnalytics.getFunnel`](webAnalytics.md#op-getfunnel) | read |
|
|
230
|
+
| GET | `/api/v1/analytics/conversions/goals` | [`g8.api.webAnalytics.getGoals`](webAnalytics.md#op-getgoals) | read |
|
|
231
|
+
| GET | `/api/v1/analytics/conversions/goals/trend` | [`g8.api.webAnalytics.getGoalsTrend`](webAnalytics.md#op-getgoalstrend) | read |
|
|
232
|
+
| GET | `/api/v1/analytics/conversions/rate` | [`g8.api.webAnalytics.getConversionRate`](webAnalytics.md#op-getconversionrate) | read |
|
|
233
|
+
| GET | `/api/v1/analytics/data-sources` | [`g8.api.analytics.getAnalyticsDataSources`](analytics.md#op-getanalyticsdatasources) | read |
|
|
234
|
+
| POST | `/api/v1/analytics/dialer/grading/search` | [`g8.api.dialerAnalytics.searchGradedCalls`](dialerAnalytics.md#op-searchgradedcalls) | read |
|
|
235
|
+
| GET | `/api/v1/analytics/dialer/leaderboard` | [`g8.api.dialerAnalytics.getDialerLeaderboard`](dialerAnalytics.md#op-getdialerleaderboard) | read |
|
|
236
|
+
| GET | `/api/v1/analytics/dialer/leaderboard/sdr/{sdr_email}` | [`g8.api.dialerAnalytics.getSdrDialerDetail`](dialerAnalytics.md#op-getsdrdialerdetail) | read |
|
|
237
|
+
| GET | `/api/v1/analytics/dialer/performance` | [`g8.api.dialerAnalytics.getDialerPerformance`](dialerAnalytics.md#op-getdialerperformance) | read |
|
|
238
|
+
| GET | `/api/v1/analytics/dialer/quality` | [`g8.api.dialerAnalytics.getDialerQuality`](dialerAnalytics.md#op-getdialerquality) | read |
|
|
239
|
+
| GET | `/api/v1/analytics/dialer/quality/leaderboard` | [`g8.api.dialerAnalytics.getQualityLeaderboard`](dialerAnalytics.md#op-getqualityleaderboard) | read |
|
|
240
|
+
| GET | `/api/v1/analytics/engagement/by-campaign` | [`g8.api.webAnalytics.getEngagementByCampaign`](webAnalytics.md#op-getengagementbycampaign) | read |
|
|
241
|
+
| GET | `/api/v1/analytics/engagement/by-channel` | [`g8.api.webAnalytics.getEngagementByChannel`](webAnalytics.md#op-getengagementbychannel) | read |
|
|
242
|
+
| GET | `/api/v1/analytics/engagement/by-landing-page` | [`g8.api.webAnalytics.getEngagementByLandingPage`](webAnalytics.md#op-getengagementbylandingpage) | read |
|
|
243
|
+
| GET | `/api/v1/analytics/engagement/depth-distribution` | [`g8.api.webAnalytics.getSessionDepthDistribution`](webAnalytics.md#op-getsessiondepthdistribution) | read |
|
|
244
|
+
| GET | `/api/v1/analytics/engagement/overview` | [`g8.api.webAnalytics.getEngagementOverview`](webAnalytics.md#op-getengagementoverview) | read |
|
|
245
|
+
| GET | `/api/v1/analytics/engagement/time-distribution` | [`g8.api.webAnalytics.getTimeOnSiteDistribution`](webAnalytics.md#op-gettimeonsitedistribution) | read |
|
|
246
|
+
| GET | `/api/v1/analytics/engagement/trend` | [`g8.api.webAnalytics.getEngagementTrend`](webAnalytics.md#op-getengagementtrend) | read |
|
|
247
|
+
| GET | `/api/v1/analytics/launchpad/activity-profile` | [`g8.api.analytics.getLaunchpadActivityProfile`](analytics.md#op-getlaunchpadactivityprofile) | read |
|
|
248
|
+
| GET | `/api/v1/analytics/launchpad/briefing` | [`g8.api.analytics.getLaunchpadBriefing`](analytics.md#op-getlaunchpadbriefing) | read |
|
|
249
|
+
| GET | `/api/v1/analytics/launchpad/calendar/today` | [`g8.api.analytics.getLaunchpadCalendarToday`](analytics.md#op-getlaunchpadcalendartoday) | read |
|
|
250
|
+
| GET | `/api/v1/analytics/launchpad/home-feed` | [`g8.api.analytics.getLaunchpadHomeFeed`](analytics.md#op-getlaunchpadhomefeed) | read |
|
|
251
|
+
| GET | `/api/v1/analytics/launchpad/smart-cards` | [`g8.api.analytics.getLaunchpadSmartCards`](analytics.md#op-getlaunchpadsmartcards) | read |
|
|
252
|
+
| GET | `/api/v1/analytics/marketing/campaigns` | [`g8.api.marketingIntelligence.getCampaignsWithAttribution`](marketingIntelligence.md#op-getcampaignswithattribution) | read |
|
|
253
|
+
| GET | `/api/v1/analytics/marketing/content` | [`g8.api.marketingIntelligence.getContentWithAttribution`](marketingIntelligence.md#op-getcontentwithattribution) | read |
|
|
254
|
+
| GET | `/api/v1/analytics/marketing/content/by-landing` | [`g8.api.marketingIntelligence.getLandingPagesWithAttribution`](marketingIntelligence.md#op-getlandingpageswithattribution) | read |
|
|
255
|
+
| GET | `/api/v1/analytics/marketing/outbound-bridge` | [`g8.api.marketingIntelligence.getOutboundBridgeOverview`](marketingIntelligence.md#op-getoutboundbridgeoverview) | read |
|
|
256
|
+
| GET | `/api/v1/analytics/marketing/outbound-bridge/by-campaign` | [`g8.api.marketingIntelligence.getOutboundBridgeByCampaign`](marketingIntelligence.md#op-getoutboundbridgebycampaign) | read |
|
|
257
|
+
| GET | `/api/v1/analytics/marketing/outbound-bridge/by-channel` | [`g8.api.marketingIntelligence.getOutboundBridgeByChannel`](marketingIntelligence.md#op-getoutboundbridgebychannel) | read |
|
|
258
|
+
| GET | `/api/v1/analytics/marketing/outbound-bridge/by-landing-page` | [`g8.api.marketingIntelligence.getOutboundBridgeByLandingPage`](marketingIntelligence.md#op-getoutboundbridgebylandingpage) | read |
|
|
259
|
+
| GET | `/api/v1/analytics/marketing/outbound-bridge/top-sources` | [`g8.api.marketingIntelligence.getTopPerformingSources`](marketingIntelligence.md#op-gettopperformingsources) | read |
|
|
260
|
+
| GET | `/api/v1/analytics/marketing/outbound-bridge/trend` | [`g8.api.marketingIntelligence.getOutboundBridgeTrend`](marketingIntelligence.md#op-getoutboundbridgetrend) | read |
|
|
261
|
+
| GET | `/api/v1/analytics/marketing/overview` | [`g8.api.marketingIntelligence.getMarketingOverview`](marketingIntelligence.md#op-getmarketingoverview) | read |
|
|
262
|
+
| GET | `/api/v1/analytics/outbound/audience/industry` | [`g8.api.analytics.getAudienceByIndustry`](analytics.md#op-getaudiencebyindustry) | read |
|
|
263
|
+
| GET | `/api/v1/analytics/outbound/audience/industry-group` | [`g8.api.analytics.getAudienceByIndustryGroup`](analytics.md#op-getaudiencebyindustrygroup) | read |
|
|
264
|
+
| GET | `/api/v1/analytics/outbound/audience/seniority` | [`g8.api.analytics.getAudienceBySeniority`](analytics.md#op-getaudiencebyseniority) | read |
|
|
265
|
+
| GET | `/api/v1/analytics/outbound/call-metrics` | [`g8.api.analytics.getCallMetrics`](analytics.md#op-getcallmetrics) | read |
|
|
266
|
+
| GET | `/api/v1/analytics/outbound/call-metrics/trend` | [`g8.api.analytics.getCallTrend`](analytics.md#op-getcalltrend) | read |
|
|
267
|
+
| GET | `/api/v1/analytics/outbound/call-metrics/voice-ai` | [`g8.api.analytics.getVoiceAiOutcomes`](analytics.md#op-getvoiceaioutcomes) | read |
|
|
268
|
+
| GET | `/api/v1/analytics/outbound/channel-attribution` | [`g8.api.analytics.getChannelAttribution`](analytics.md#op-getchannelattribution) | read |
|
|
269
|
+
| GET | `/api/v1/analytics/outbound/dashboards/campaign` | [`g8.api.analytics.getCampaignDashboard`](analytics.md#op-getcampaigndashboard) | read |
|
|
270
|
+
| GET | `/api/v1/analytics/outbound/dashboards/executive` | [`g8.api.analytics.getExecutiveDashboard`](analytics.md#op-getexecutivedashboard) | read |
|
|
271
|
+
| GET | `/api/v1/analytics/outbound/dashboards/manager` | [`g8.api.analytics.getManagerDashboard`](analytics.md#op-getmanagerdashboard) | read |
|
|
272
|
+
| GET | `/api/v1/analytics/outbound/dashboards/sdr` | [`g8.api.analytics.getMySdrDashboard`](analytics.md#op-getmysdrdashboard) | read |
|
|
273
|
+
| GET | `/api/v1/analytics/outbound/dashboards/sdr/{sdr_email}` | [`g8.api.analytics.getSdrDashboardByEmail`](analytics.md#op-getsdrdashboardbyemail) | read |
|
|
274
|
+
| GET | `/api/v1/analytics/outbound/email-metrics` | [`g8.api.analytics.getEmailMetrics`](analytics.md#op-getemailmetrics) | read |
|
|
275
|
+
| GET | `/api/v1/analytics/outbound/email-metrics/by-sequence` | [`g8.api.analytics.getEmailBySequence`](analytics.md#op-getemailbysequence) | read |
|
|
276
|
+
| GET | `/api/v1/analytics/outbound/email-metrics/by-step` | [`g8.api.analytics.getEmailByStep`](analytics.md#op-getemailbystep) | read |
|
|
277
|
+
| GET | `/api/v1/analytics/outbound/email-metrics/trend` | [`g8.api.analytics.getEmailTrend`](analytics.md#op-getemailtrend) | read |
|
|
278
|
+
| GET | `/api/v1/analytics/outbound/meeting-funnel` | [`g8.api.analytics.getMeetingFunnel`](analytics.md#op-getmeetingfunnel) | read |
|
|
279
|
+
| GET | `/api/v1/analytics/outbound/meeting-metrics` | [`g8.api.analytics.getMeetingMetrics`](analytics.md#op-getmeetingmetrics) | read |
|
|
280
|
+
| GET | `/api/v1/analytics/outbound/meeting-metrics/by-channel` | [`g8.api.analytics.getMeetingByChannel`](analytics.md#op-getmeetingbychannel) | read |
|
|
281
|
+
| GET | `/api/v1/analytics/outbound/meeting-metrics/trend` | [`g8.api.analytics.getMeetingTrend`](analytics.md#op-getmeetingtrend) | read |
|
|
282
|
+
| GET | `/api/v1/analytics/outbound/sdr-activity` | [`g8.api.analytics.getSdrActivity`](analytics.md#op-getsdractivity) | read |
|
|
283
|
+
| GET | `/api/v1/analytics/outbound/sdr-activity/daily` | [`g8.api.analytics.getSdrDaily`](analytics.md#op-getsdrdaily) | read |
|
|
284
|
+
| GET | `/api/v1/analytics/outbound/sdr-activity/leaderboard` | [`g8.api.analytics.getSdrLeaderboard`](analytics.md#op-getsdrleaderboard) | read |
|
|
285
|
+
| GET | `/api/v1/analytics/outbound/sdr-activity/team-comparison` | [`g8.api.analytics.getTeamComparison`](analytics.md#op-getteamcomparison) | read |
|
|
286
|
+
| GET | `/api/v1/analytics/outbound/sdr-activity/{sdr_email}` | [`g8.api.analytics.getSdrActivityByEmail`](analytics.md#op-getsdractivitybyemail) | read |
|
|
287
|
+
| GET | `/api/v1/analytics/outbound/sequence-performance` | [`g8.api.analytics.getSequencePerformance`](analytics.md#op-getsequenceperformance) | read |
|
|
288
|
+
| GET | `/api/v1/analytics/outbound/sequence-performance/{sequence_id}` | [`g8.api.analytics.getSequencePerformanceById`](analytics.md#op-getsequenceperformancebyid) | read |
|
|
289
|
+
| GET | `/api/v1/analytics/outbound/summary` | [`g8.api.analytics.getOutboundSummary`](analytics.md#op-getoutboundsummary) | read |
|
|
290
|
+
| GET | `/api/v1/analytics/product-usage/activation-funnel` | [`g8.api.analytics.getActivationFunnel`](analytics.md#op-getactivationfunnel) | read |
|
|
291
|
+
| GET | `/api/v1/analytics/product-usage/active-users` | [`g8.api.analytics.getActiveUsers`](analytics.md#op-getactiveusers) | read |
|
|
292
|
+
| GET | `/api/v1/analytics/product-usage/feature-adoption` | [`g8.api.analytics.getFeatureAdoption`](analytics.md#op-getfeatureadoption) | read |
|
|
293
|
+
| GET | `/api/v1/analytics/product-usage/top-pages` | [`g8.api.analytics.getTopPages`](analytics.md#op-gettoppages) | read |
|
|
294
|
+
| GET | `/api/v1/analytics/realtime` | [`g8.api.webAnalytics.getRealtime`](webAnalytics.md#op-getrealtime) | read |
|
|
295
|
+
| GET | `/api/v1/analytics/realtime/locations` | [`g8.api.webAnalytics.getRealtimeLocations`](webAnalytics.md#op-getrealtimelocations) | read |
|
|
296
|
+
| GET | `/api/v1/analytics/realtime/pages` | [`g8.api.webAnalytics.getRealtimePages`](webAnalytics.md#op-getrealtimepages) | read |
|
|
297
|
+
| GET | `/api/v1/analytics/realtime/sources` | [`g8.api.webAnalytics.getRealtimeSources`](webAnalytics.md#op-getrealtimesources) | read |
|
|
298
|
+
| POST | `/api/v1/analytics/sales-report/cohort` | [`g8.api.analytics.computeCohort`](analytics.md#op-computecohort) | read |
|
|
299
|
+
| POST | `/api/v1/analytics/sales-report/cohort/explain` | [`g8.api.analytics.explainCohort`](analytics.md#op-explaincohort) | read |
|
|
300
|
+
| GET | `/api/v1/analytics/sales-report/data-quality` | [`g8.api.analytics.getDataQuality`](analytics.md#op-getdataquality) | read |
|
|
301
|
+
| POST | `/api/v1/analytics/sales-report/data-quality` | [`g8.api.analytics.postDataQuality`](analytics.md#op-postdataquality) | read |
|
|
302
|
+
| POST | `/api/v1/analytics/sales-report/export` | [`g8.api.analytics.exportCohortCsv`](analytics.md#op-exportcohortcsv) | read |
|
|
303
|
+
| GET | `/api/v1/analytics/sales-report/filter-options` | [`g8.api.analytics.getFilterOptions`](analytics.md#op-getfilteroptions) | read |
|
|
304
|
+
| GET | `/api/v1/analytics/sdr/ai-agents/summary` | [`g8.api.sdrAnalytics.getAiAgentsSummary`](sdrAnalytics.md#op-getaiagentssummary) | read |
|
|
305
|
+
| GET | `/api/v1/analytics/sdr/leaderboard` | [`g8.api.sdrAnalytics.getSdrLeaderboard`](sdrAnalytics.md#op-getsdrleaderboard) | read |
|
|
306
|
+
| GET | `/api/v1/analytics/sdr/summary` | [`g8.api.sdrAnalytics.getSdrSummary`](sdrAnalytics.md#op-getsdrsummary) | read |
|
|
307
|
+
| GET | `/api/v1/analytics/sdr/trends` | [`g8.api.sdrAnalytics.getSdrTrends`](sdrAnalytics.md#op-getsdrtrends) | read |
|
|
308
|
+
| GET | `/api/v1/analytics/sdr/{sdr_email}` | [`g8.api.sdrAnalytics.getSdrDetail`](sdrAnalytics.md#op-getsdrdetail) | read |
|
|
309
|
+
| GET | `/api/v1/analytics/subscriptions/dunning` | [`g8.api.analytics.getDunning`](analytics.md#op-getdunning) | read |
|
|
310
|
+
| GET | `/api/v1/analytics/subscriptions/movement` | [`g8.api.analytics.getMovement`](analytics.md#op-getmovement) | read |
|
|
311
|
+
| GET | `/api/v1/analytics/subscriptions/mrr` | [`g8.api.analytics.getMrr`](analytics.md#op-getmrr) | read |
|
|
312
|
+
| GET | `/api/v1/analytics/subscriptions/plan-distribution` | [`g8.api.analytics.getPlanDistribution`](analytics.md#op-getplandistribution) | read |
|
|
313
|
+
| GET | `/api/v1/analytics/subscriptions/retention` | [`g8.api.analytics.getRetention`](analytics.md#op-getretention) | read |
|
|
314
|
+
| GET | `/api/v1/analytics/subscriptions/trial-conversion` | [`g8.api.analytics.getTrialConversion`](analytics.md#op-gettrialconversion) | read |
|
|
315
|
+
| GET | `/api/v1/analytics/team/conversion-funnel` | [`g8.api.revenueAnalytics.getTeamConversionFunnel`](revenueAnalytics.md#op-getteamconversionfunnel) | read |
|
|
316
|
+
| GET | `/api/v1/analytics/team/dashboard` | [`g8.api.revenueAnalytics.getTeamRevenueDashboard`](revenueAnalytics.md#op-getteamrevenuedashboard) | read |
|
|
317
|
+
| GET | `/api/v1/analytics/team/forecast` | [`g8.api.revenueAnalytics.getTeamRevenueForecast`](revenueAnalytics.md#op-getteamrevenueforecast) | read |
|
|
318
|
+
| GET | `/api/v1/analytics/team/pipeline-velocity` | [`g8.api.revenueAnalytics.getTeamPipelineVelocity`](revenueAnalytics.md#op-getteampipelinevelocity) | read |
|
|
319
|
+
| GET | `/api/v1/api-keys` | [`g8.api.apiKeys.listApiKeys`](apiKeys.md#op-listapikeys) | read |
|
|
320
|
+
| POST | `/api/v1/api-keys` | [`g8.api.apiKeys.createApiKey`](apiKeys.md#op-createapikey) | write |
|
|
321
|
+
| GET | `/api/v1/api-keys/scopes` | [`g8.api.apiKeys.listScopeCatalog`](apiKeys.md#op-listscopecatalog) | read |
|
|
322
|
+
| DELETE | `/api/v1/api-keys/{api_key_id}` | [`g8.api.apiKeys.deleteApiKey`](apiKeys.md#op-deleteapikey) | destructive |
|
|
323
|
+
| PUT | `/api/v1/api-keys/{api_key_id}/ip-allowlist` | [`g8.api.apiKeys.updateIpAllowlist`](apiKeys.md#op-updateipallowlist) | write |
|
|
324
|
+
| POST | `/api/v1/api-keys/{api_key_id}/rotate` | [`g8.api.apiKeys.rotateApiKey`](apiKeys.md#op-rotateapikey) | write |
|
|
325
|
+
| GET | `/api/v1/app-page-sources` | [`g8.api.appPages.listAppPageSourceKinds`](appPages.md#op-listapppagesourcekinds) | read |
|
|
326
|
+
| GET | `/api/v1/app-page-sources/{source_kind}/instances` | [`g8.api.appPages.listAppPageSourceInstances`](appPages.md#op-listapppagesourceinstances) | read |
|
|
327
|
+
| GET | `/api/v1/app-pages` | [`g8.api.appPages.listAppPages`](appPages.md#op-listapppages) | read |
|
|
328
|
+
| POST | `/api/v1/app-pages` | [`g8.api.appPages.createAppPage`](appPages.md#op-createapppage) | write |
|
|
329
|
+
| DELETE | `/api/v1/app-pages/{page_id}` | [`g8.api.appPages.deleteAppPage`](appPages.md#op-deleteapppage) | destructive |
|
|
330
|
+
| GET | `/api/v1/app-pages/{page_id}` | [`g8.api.appPages.getAppPage`](appPages.md#op-getapppage) | read |
|
|
331
|
+
| GET | `/api/v1/app-pages/{page_id}/actions` | [`g8.api.appPages.listAppPageActions`](appPages.md#op-listapppageactions) | read |
|
|
332
|
+
| POST | `/api/v1/app-pages/{page_id}/actions/{alias}/{action_name}` | [`g8.api.appPages.invokeAppPageAction`](appPages.md#op-invokeapppageaction) | write |
|
|
333
|
+
| GET | `/api/v1/app-pages/{page_id}/artifact` | [`g8.api.appPages.getAppPageArtifact`](appPages.md#op-getapppageartifact) | read |
|
|
334
|
+
| POST | `/api/v1/app-pages/{page_id}/chat-edit` | [`g8.api.appPages.chatEditAppPage`](appPages.md#op-chateditapppage) | write |
|
|
335
|
+
| POST | `/api/v1/app-pages/{page_id}/frame-session` | [`g8.api.appPages.mintAppPageFrameSession`](appPages.md#op-mintapppageframesession) | write |
|
|
336
|
+
| POST | `/api/v1/app-pages/{page_id}/generate` | [`g8.api.appPages.generateAppPage`](appPages.md#op-generateapppage) | billable |
|
|
337
|
+
| PUT | `/api/v1/app-pages/{page_id}/sources` | [`g8.api.appPages.replaceAppPageSources`](appPages.md#op-replaceapppagesources) | write |
|
|
338
|
+
| GET | `/api/v1/app-pages/{page_id}/status` | [`g8.api.appPages.getAppPageStatus`](appPages.md#op-getapppagestatus) | read |
|
|
339
|
+
| GET | `/api/v1/app-pages/{page_id}/versions` | [`g8.api.appPages.listAppPageVersions`](appPages.md#op-listapppageversions) | read |
|
|
340
|
+
| POST | `/api/v1/app-pages/{page_id}/versions/{version_num}/restore` | [`g8.api.appPages.restoreAppPageVersion`](appPages.md#op-restoreapppageversion) | write |
|
|
341
|
+
| GET | `/api/v1/app-platform/.well-known/jwks.json` | [`g8.api.appPlatformTokens.appTokenJwks`](appPlatformTokens.md#op-apptokenjwks) | read |
|
|
342
|
+
| GET | `/api/v1/app-platform/tls-authorize` | [`g8.api.appDomains.tlsAuthorize`](appDomains.md#op-tlsauthorize) | read |
|
|
343
|
+
| POST | `/api/v1/app-sessions/exchange` | [`g8.api.appPlatformTokens.exchangeAppSession`](appPlatformTokens.md#op-exchangeappsession) | write |
|
|
344
|
+
| GET | `/api/v1/app/objects` | [`g8.api.appObjects.listAppObjects`](appObjects.md#op-listappobjects) | read |
|
|
345
|
+
| GET | `/api/v1/app/objects/{object_slug}` | [`g8.api.appObjects.getAppObject`](appObjects.md#op-getappobject) | read |
|
|
346
|
+
| GET | `/api/v1/app/objects/{object_slug}/attributes` | [`g8.api.appObjects.listAppObjectAttributes`](appObjects.md#op-listappobjectattributes) | read |
|
|
347
|
+
| GET | `/api/v1/app/objects/{object_slug}/records` | [`g8.api.appObjects.listAppObjectRecords`](appObjects.md#op-listappobjectrecords) | read |
|
|
348
|
+
| POST | `/api/v1/app/objects/{object_slug}/records` | [`g8.api.appObjects.createAppObjectRecord`](appObjects.md#op-createappobjectrecord) | write |
|
|
349
|
+
| GET | `/api/v1/app/objects/{object_slug}/records/{record_id}` | [`g8.api.appObjects.getAppObjectRecord`](appObjects.md#op-getappobjectrecord) | read |
|
|
350
|
+
| PATCH | `/api/v1/app/objects/{object_slug}/records/{record_id}` | [`g8.api.appObjects.updateAppObjectRecord`](appObjects.md#op-updateappobjectrecord) | write |
|
|
351
|
+
| GET | `/api/v1/app/objects/{object_slug}/records/{record_id}/changes` | [`g8.api.appObjects.getAppObjectRecordChanges`](appObjects.md#op-getappobjectrecordchanges) | read |
|
|
352
|
+
| GET | `/api/v1/app/objects/{object_slug}/records/{record_id}/history` | [`g8.api.appObjects.getAppObjectRecordHistory`](appObjects.md#op-getappobjectrecordhistory) | read |
|
|
353
|
+
| POST | `/api/v1/app/objects/{object_slug}/records/{record_id}/restore` | [`g8.api.appObjects.restoreAppObjectRecord`](appObjects.md#op-restoreappobjectrecord) | write |
|
|
354
|
+
| GET | `/api/v1/appointments/availability/team` | [`g8.api.appointments.listTeamAvailability`](appointments.md#op-listteamavailability) | read |
|
|
355
|
+
| GET | `/api/v1/appointments/bookings` | [`g8.api.appointments.listBookings`](appointments.md#op-listbookings) | read |
|
|
356
|
+
| POST | `/api/v1/appointments/bookings` | [`g8.api.appointments.createBooking`](appointments.md#op-createbooking) | external |
|
|
357
|
+
| POST | `/api/v1/appointments/bookings/import` | [`g8.api.appointments.importMeeting`](appointments.md#op-importmeeting) | external |
|
|
358
|
+
| GET | `/api/v1/appointments/bookings/insights` | [`g8.api.appointments.getBookingInsights`](appointments.md#op-getbookinginsights) | read |
|
|
359
|
+
| GET | `/api/v1/appointments/bookings/insights/export` | [`g8.api.appointments.exportBookingInsights`](appointments.md#op-exportbookinginsights) | read |
|
|
360
|
+
| GET | `/api/v1/appointments/bookings/sequences-picker` | [`g8.api.appointments.listSequencesForPicker`](appointments.md#op-listsequencesforpicker) | read |
|
|
361
|
+
| GET | `/api/v1/appointments/bookings/{booking_uid}` | [`g8.api.appointments.getBooking`](appointments.md#op-getbooking) | read |
|
|
362
|
+
| POST | `/api/v1/appointments/bookings/{booking_uid}/cancel` | [`g8.api.appointments.cancelBooking`](appointments.md#op-cancelbooking) | destructive |
|
|
363
|
+
| POST | `/api/v1/appointments/bookings/{booking_uid}/confirm` | [`g8.api.appointments.confirmBooking`](appointments.md#op-confirmbooking) | external |
|
|
364
|
+
| POST | `/api/v1/appointments/bookings/{booking_uid}/guests` | [`g8.api.appointments.addBookingGuests`](appointments.md#op-addbookingguests) | external |
|
|
365
|
+
| PATCH | `/api/v1/appointments/bookings/{booking_uid}/location` | [`g8.api.appointments.updateBookingLocation`](appointments.md#op-updatebookinglocation) | external |
|
|
366
|
+
| POST | `/api/v1/appointments/bookings/{booking_uid}/mark-absent` | [`g8.api.appointments.markAbsent`](appointments.md#op-markabsent) | external |
|
|
367
|
+
| POST | `/api/v1/appointments/bookings/{booking_uid}/notes` | [`g8.api.appointments.addBookingNote`](appointments.md#op-addbookingnote) | external |
|
|
368
|
+
| POST | `/api/v1/appointments/bookings/{booking_uid}/request-reschedule` | [`g8.api.appointments.requestBookingReschedule`](appointments.md#op-requestbookingreschedule) | external |
|
|
369
|
+
| POST | `/api/v1/appointments/bookings/{booking_uid}/reschedule` | [`g8.api.appointments.rescheduleBooking`](appointments.md#op-reschedulebooking) | external |
|
|
370
|
+
| PATCH | `/api/v1/appointments/bookings/{booking_uid}/sequence` | [`g8.api.appointments.updateBookingSequence`](appointments.md#op-updatebookingsequence) | external |
|
|
371
|
+
| GET | `/api/v1/appointments/calendars` | [`g8.api.appointments.listCalendars`](appointments.md#op-listcalendars) | read |
|
|
372
|
+
| GET | `/api/v1/appointments/calendars/destination` | [`g8.api.appointments.getDestinationCalendar`](appointments.md#op-getdestinationcalendar) | read |
|
|
373
|
+
| PUT | `/api/v1/appointments/calendars/destination` | [`g8.api.appointments.setDestinationCalendar`](appointments.md#op-setdestinationcalendar) | external |
|
|
374
|
+
| GET | `/api/v1/appointments/calendars/events` | [`g8.api.appointments.listCalendarEvents`](appointments.md#op-listcalendarevents) | read |
|
|
375
|
+
| DELETE | `/api/v1/appointments/calendars/selected` | [`g8.api.appointments.deselectCalendar`](appointments.md#op-deselectcalendar) | destructive |
|
|
376
|
+
| POST | `/api/v1/appointments/calendars/selected` | [`g8.api.appointments.selectCalendar`](appointments.md#op-selectcalendar) | external |
|
|
377
|
+
| DELETE | `/api/v1/appointments/calendars/{credential_id}` | [`g8.api.appointments.disconnectCalendar`](appointments.md#op-disconnectcalendar) | destructive |
|
|
378
|
+
| GET | `/api/v1/appointments/conferencing` | [`g8.api.appointments.listConferencing`](appointments.md#op-listconferencing) | read |
|
|
379
|
+
| POST | `/api/v1/appointments/conferencing/connect/{provider}` | [`g8.api.appointments.connectConferencing`](appointments.md#op-connectconferencing) | external |
|
|
380
|
+
| GET | `/api/v1/appointments/conferencing/default` | [`g8.api.appointments.getDefaultConferencing`](appointments.md#op-getdefaultconferencing) | read |
|
|
381
|
+
| POST | `/api/v1/appointments/conferencing/{provider}/default` | [`g8.api.appointments.setDefaultConferencing`](appointments.md#op-setdefaultconferencing) | external |
|
|
382
|
+
| DELETE | `/api/v1/appointments/conferencing/{provider}/disconnect` | [`g8.api.appointments.disconnectConferencing`](appointments.md#op-disconnectconferencing) | destructive |
|
|
383
|
+
| PUT | `/api/v1/appointments/conferencing/{provider}/link` | [`g8.api.appointments.setProviderLink`](appointments.md#op-setproviderlink) | external |
|
|
384
|
+
| POST | `/api/v1/appointments/event-types` | [`g8.api.appointments.createEventType`](appointments.md#op-createeventtype) | write |
|
|
385
|
+
| DELETE | `/api/v1/appointments/event-types/{event_type_id}` | [`g8.api.appointments.deleteEventType`](appointments.md#op-deleteeventtype) | destructive |
|
|
386
|
+
| GET | `/api/v1/appointments/event-types/{event_type_id}` | [`g8.api.appointments.getEventType`](appointments.md#op-geteventtype) | read |
|
|
387
|
+
| PATCH | `/api/v1/appointments/event-types/{event_type_id}` | [`g8.api.appointments.updateEventType`](appointments.md#op-updateeventtype) | write |
|
|
388
|
+
| DELETE | `/api/v1/appointments/event-types/{event_type_id}/destination-calendar` | [`g8.api.appointments.clearEventTypeDestinationCalendar`](appointments.md#op-cleareventtypedestinationcalendar) | destructive |
|
|
389
|
+
| GET | `/api/v1/appointments/event-types/{event_type_id}/destination-calendar` | [`g8.api.appointments.getEventTypeDestinationCalendar`](appointments.md#op-geteventtypedestinationcalendar) | read |
|
|
390
|
+
| PUT | `/api/v1/appointments/event-types/{event_type_id}/destination-calendar` | [`g8.api.appointments.setEventTypeDestinationCalendar`](appointments.md#op-seteventtypedestinationcalendar) | write |
|
|
391
|
+
| POST | `/api/v1/appointments/event-types/{event_type_id}/duplicate` | [`g8.api.appointments.duplicateEventType`](appointments.md#op-duplicateeventtype) | write |
|
|
392
|
+
| GET | `/api/v1/appointments/event-types/{event_type_id}/embed` | [`g8.api.appointments.getEmbedConfig`](appointments.md#op-getembedconfig) | read |
|
|
393
|
+
| PATCH | `/api/v1/appointments/event-types/{event_type_id}/embed` | [`g8.api.appointments.updateEmbedConfig`](appointments.md#op-updateembedconfig) | write |
|
|
394
|
+
| GET | `/api/v1/appointments/event-types/{event_type_id}/host-groups` | [`g8.api.appointments.listEventTypeHostGroups`](appointments.md#op-listeventtypehostgroups) | read |
|
|
395
|
+
| POST | `/api/v1/appointments/event-types/{event_type_id}/host-groups` | [`g8.api.appointments.createEventTypeHostGroup`](appointments.md#op-createeventtypehostgroup) | write |
|
|
396
|
+
| DELETE | `/api/v1/appointments/event-types/{event_type_id}/host-groups/{group_id}` | [`g8.api.appointments.deleteEventTypeHostGroup`](appointments.md#op-deleteeventtypehostgroup) | destructive |
|
|
397
|
+
| PATCH | `/api/v1/appointments/event-types/{event_type_id}/host-groups/{group_id}` | [`g8.api.appointments.updateEventTypeHostGroup`](appointments.md#op-updateeventtypehostgroup) | write |
|
|
398
|
+
| POST | `/api/v1/appointments/event-types/{event_type_id}/hosts` | [`g8.api.appointments.addEventTypeHost`](appointments.md#op-addeventtypehost) | write |
|
|
399
|
+
| DELETE | `/api/v1/appointments/event-types/{event_type_id}/hosts/{host_user_id}` | [`g8.api.appointments.removeEventTypeHost`](appointments.md#op-removeeventtypehost) | destructive |
|
|
400
|
+
| PATCH | `/api/v1/appointments/event-types/{event_type_id}/hosts/{host_user_id}` | [`g8.api.appointments.updateEventTypeHost`](appointments.md#op-updateeventtypehost) | write |
|
|
401
|
+
| PUT | `/api/v1/appointments/event-types/{event_type_id}/locked-fields` | [`g8.api.appointments.setLockedFields`](appointments.md#op-setlockedfields) | write |
|
|
402
|
+
| POST | `/api/v1/appointments/event-types/{event_type_id}/members` | [`g8.api.appointments.assignManagedMember`](appointments.md#op-assignmanagedmember) | write |
|
|
403
|
+
| POST | `/api/v1/appointments/event-types/{event_type_id}/members/all` | [`g8.api.appointments.assignAllMembers`](appointments.md#op-assignallmembers) | write |
|
|
404
|
+
| DELETE | `/api/v1/appointments/event-types/{event_type_id}/members/{user_id}` | [`g8.api.appointments.unassignManagedMember`](appointments.md#op-unassignmanagedmember) | destructive |
|
|
405
|
+
| GET | `/api/v1/appointments/event-types/{event_type_id}/selected-calendars` | [`g8.api.appointments.getEventTypeSelectedCalendars`](appointments.md#op-geteventtypeselectedcalendars) | read |
|
|
406
|
+
| PUT | `/api/v1/appointments/event-types/{event_type_id}/selected-calendars` | [`g8.api.appointments.setEventTypeSelectedCalendars`](appointments.md#op-seteventtypeselectedcalendars) | write |
|
|
407
|
+
| GET | `/api/v1/appointments/membership` | [`g8.api.appointments.listMembership`](appointments.md#op-listmembership) | read |
|
|
408
|
+
| PATCH | `/api/v1/appointments/membership/by-user/{user_id}/role` | [`g8.api.appointments.updateMemberRole`](appointments.md#op-updatememberrole) | destructive |
|
|
409
|
+
| GET | `/api/v1/appointments/org-settings` | [`g8.api.appointments.getOrgSettings`](appointments.md#op-getorgsettings) | read |
|
|
410
|
+
| PATCH | `/api/v1/appointments/org-settings` | [`g8.api.appointments.updateOrgSettings`](appointments.md#op-updateorgsettings) | write |
|
|
411
|
+
| GET | `/api/v1/appointments/out-of-office` | [`g8.api.appointments.listOoo`](appointments.md#op-listooo) | read |
|
|
412
|
+
| POST | `/api/v1/appointments/out-of-office` | [`g8.api.appointments.createOoo`](appointments.md#op-createooo) | write |
|
|
413
|
+
| DELETE | `/api/v1/appointments/out-of-office/{ooo_uuid}` | [`g8.api.appointments.deleteOoo`](appointments.md#op-deleteooo) | destructive |
|
|
414
|
+
| PATCH | `/api/v1/appointments/out-of-office/{ooo_uuid}` | [`g8.api.appointments.updateOoo`](appointments.md#op-updateooo) | write |
|
|
415
|
+
| GET | `/api/v1/appointments/profile` | [`g8.api.appointments.getScheduleProfile`](appointments.md#op-getscheduleprofile) | read |
|
|
416
|
+
| PATCH | `/api/v1/appointments/profile` | [`g8.api.appointments.updateScheduleProfile`](appointments.md#op-updatescheduleprofile) | write |
|
|
417
|
+
| GET | `/api/v1/appointments/routing-forms` | [`g8.api.appointments.listRoutingForms`](appointments.md#op-listroutingforms) | read |
|
|
418
|
+
| POST | `/api/v1/appointments/routing-forms` | [`g8.api.appointments.createRoutingForm`](appointments.md#op-createroutingform) | write |
|
|
419
|
+
| DELETE | `/api/v1/appointments/routing-forms/{form_id}` | [`g8.api.appointments.deleteRoutingForm`](appointments.md#op-deleteroutingform) | destructive |
|
|
420
|
+
| GET | `/api/v1/appointments/routing-forms/{form_id}` | [`g8.api.appointments.getRoutingForm`](appointments.md#op-getroutingform) | read |
|
|
421
|
+
| PATCH | `/api/v1/appointments/routing-forms/{form_id}` | [`g8.api.appointments.updateRoutingForm`](appointments.md#op-updateroutingform) | write |
|
|
422
|
+
| POST | `/api/v1/appointments/routing-forms/{form_id}/duplicate` | [`g8.api.appointments.duplicateRoutingForm`](appointments.md#op-duplicateroutingform) | write |
|
|
423
|
+
| GET | `/api/v1/appointments/routing-forms/{form_id}/responses` | [`g8.api.appointments.listRoutingFormResponses`](appointments.md#op-listroutingformresponses) | read |
|
|
424
|
+
| GET | `/api/v1/appointments/routing-forms/{form_id}/responses/export` | [`g8.api.appointments.exportRoutingFormResponses`](appointments.md#op-exportroutingformresponses) | read |
|
|
425
|
+
| GET | `/api/v1/appointments/saved-filters` | [`g8.api.appointments.listSavedFilters`](appointments.md#op-listsavedfilters) | read |
|
|
426
|
+
| POST | `/api/v1/appointments/saved-filters` | [`g8.api.appointments.createSavedFilter`](appointments.md#op-createsavedfilter) | write |
|
|
427
|
+
| DELETE | `/api/v1/appointments/saved-filters/{filter_id}` | [`g8.api.appointments.deleteSavedFilter`](appointments.md#op-deletesavedfilter) | destructive |
|
|
428
|
+
| PUT | `/api/v1/appointments/saved-filters/{filter_id}` | [`g8.api.appointments.updateSavedFilter`](appointments.md#op-updatesavedfilter) | write |
|
|
429
|
+
| GET | `/api/v1/appointments/schedules` | [`g8.api.appointments.listSchedules`](appointments.md#op-listschedules) | read |
|
|
430
|
+
| POST | `/api/v1/appointments/schedules` | [`g8.api.appointments.createSchedule`](appointments.md#op-createschedule) | write |
|
|
431
|
+
| DELETE | `/api/v1/appointments/schedules/{schedule_id}` | [`g8.api.appointments.deleteSchedule`](appointments.md#op-deleteschedule) | destructive |
|
|
432
|
+
| GET | `/api/v1/appointments/schedules/{schedule_id}` | [`g8.api.appointments.getSchedule`](appointments.md#op-getschedule) | read |
|
|
433
|
+
| PATCH | `/api/v1/appointments/schedules/{schedule_id}` | [`g8.api.appointments.updateSchedule`](appointments.md#op-updateschedule) | write |
|
|
434
|
+
| GET | `/api/v1/appointments/schedules/{schedule_id}/availability` | [`g8.api.appointments.getAvailability`](appointments.md#op-getavailability) | read |
|
|
435
|
+
| PATCH | `/api/v1/appointments/schedules/{schedule_id}/availability` | [`g8.api.appointments.updateAvailability`](appointments.md#op-updateavailability) | write |
|
|
436
|
+
| POST | `/api/v1/appointments/schedules/{schedule_id}/set-default` | [`g8.api.appointments.setDefaultSchedule`](appointments.md#op-setdefaultschedule) | write |
|
|
437
|
+
| GET | `/api/v1/appointments/slots` | [`g8.api.appointments.getAvailableSlots`](appointments.md#op-getavailableslots) | read |
|
|
438
|
+
| POST | `/api/v1/appointments/slots/reserve` | [`g8.api.appointments.reserveSlot`](appointments.md#op-reserveslot) | write |
|
|
439
|
+
| DELETE | `/api/v1/appointments/slots/reserve/{slot_uid}` | [`g8.api.appointments.releaseSlot`](appointments.md#op-releaseslot) | destructive |
|
|
440
|
+
| GET | `/api/v1/appointments/workflows` | [`g8.api.appointments.listWorkflows`](appointments.md#op-listworkflows) | read |
|
|
441
|
+
| POST | `/api/v1/appointments/workflows` | [`g8.api.appointments.createWorkflow`](appointments.md#op-createworkflow) | external |
|
|
442
|
+
| DELETE | `/api/v1/appointments/workflows/{workflow_id}` | [`g8.api.appointments.deleteWorkflow`](appointments.md#op-deleteworkflow) | destructive |
|
|
443
|
+
| GET | `/api/v1/appointments/workflows/{workflow_id}` | [`g8.api.appointments.getWorkflow`](appointments.md#op-getworkflow) | read |
|
|
444
|
+
| PATCH | `/api/v1/appointments/workflows/{workflow_id}` | [`g8.api.appointments.updateWorkflow`](appointments.md#op-updateworkflow) | external |
|
|
445
|
+
| POST | `/api/v1/appointments/workflows/{workflow_id}/toggle` | [`g8.api.appointments.toggleWorkflow`](appointments.md#op-toggleworkflow) | external |
|
|
446
|
+
| GET | `/api/v1/apps` | [`g8.api.apps.listApps`](apps.md#op-listapps) or `g8.apps.list()` | read |
|
|
447
|
+
| POST | `/api/v1/apps` | [`g8.api.apps.createApp`](apps.md#op-createapp) or `g8.apps.create()` | write |
|
|
448
|
+
| POST | `/api/v1/apps/manifest/validate` | [`g8.api.apps.validateAppManifest`](apps.md#op-validateappmanifest) | write |
|
|
449
|
+
| GET | `/api/v1/apps/{app_id}` | [`g8.api.apps.getApp`](apps.md#op-getapp) or `g8.apps.get()` | read |
|
|
450
|
+
| GET | `/api/v1/apps/{app_id}/credentials` | [`g8.api.apps.listAppCredentials`](apps.md#op-listappcredentials) | read |
|
|
451
|
+
| POST | `/api/v1/apps/{app_id}/credentials` | [`g8.api.apps.createAppCredential`](apps.md#op-createappcredential) | write |
|
|
452
|
+
| DELETE | `/api/v1/apps/{app_id}/credentials/{client_id}` | [`g8.api.apps.revokeAppCredential`](apps.md#op-revokeappcredential) | destructive |
|
|
453
|
+
| GET | `/api/v1/apps/{app_id}/deployments` | [`g8.api.appDeployments.listAppDeployments`](appDeployments.md#op-listappdeployments) or `g8.appPlatform.listDeployments()` | read |
|
|
454
|
+
| POST | `/api/v1/apps/{app_id}/deployments` | [`g8.api.appDeployments.createAppDeployment`](appDeployments.md#op-createappdeployment) or `g8.appPlatform.deploy()` | write |
|
|
455
|
+
| GET | `/api/v1/apps/{app_id}/deployments/active` | [`g8.api.appDeployments.getActiveDeployment`](appDeployments.md#op-getactivedeployment) or `g8.appPlatform.activeDeployment()` | read |
|
|
456
|
+
| GET | `/api/v1/apps/{app_id}/deployments/{deployment_id}` | [`g8.api.appDeployments.getDeployment`](appDeployments.md#op-getdeployment) or `g8.appPlatform.getDeployment()` | read |
|
|
457
|
+
| GET | `/api/v1/apps/{app_id}/deployments/{deployment_id}/logs` | [`g8.api.appLogs.getDeploymentLogs`](appLogs.md#op-getdeploymentlogs) or `g8.appPlatform.deploymentLogs()` | read |
|
|
458
|
+
| POST | `/api/v1/apps/{app_id}/deployments/{deployment_id}/promote` | [`g8.api.appDeployments.promoteDeployment`](appDeployments.md#op-promotedeployment) or `g8.appPlatform.promote()` | write |
|
|
459
|
+
| POST | `/api/v1/apps/{app_id}/deployments/{deployment_id}/rollback` | [`g8.api.appDeployments.rollbackDeployment`](appDeployments.md#op-rollbackdeployment) or `g8.appPlatform.rollback()` | write |
|
|
460
|
+
| POST | `/api/v1/apps/{app_id}/deployments/{deployment_id}/status` | [`g8.api.appDeployments.reportDeploymentProgress`](appDeployments.md#op-reportdeploymentprogress) | write |
|
|
461
|
+
| GET | `/api/v1/apps/{app_id}/domains` | [`g8.api.appDomains.listAppDomains`](appDomains.md#op-listappdomains) or `g8.appPlatform.listDomains()` | read |
|
|
462
|
+
| POST | `/api/v1/apps/{app_id}/domains` | [`g8.api.appDomains.claimAppDomain`](appDomains.md#op-claimappdomain) or `g8.appPlatform.claimDomain()` | write |
|
|
463
|
+
| DELETE | `/api/v1/apps/{app_id}/domains/{hostname}` | [`g8.api.appDomains.releaseAppDomain`](appDomains.md#op-releaseappdomain) or `g8.appPlatform.releaseDomain()` | destructive |
|
|
464
|
+
| POST | `/api/v1/apps/{app_id}/domains/{hostname}/verify` | [`g8.api.appDomains.verifyAppDomain`](appDomains.md#op-verifyappdomain) or `g8.appPlatform.verifyDomain()` | write |
|
|
465
|
+
| GET | `/api/v1/apps/{app_id}/installs` | [`g8.api.apps.listAppInstalls`](apps.md#op-listappinstalls) or `g8.apps.listInstalls()` | read |
|
|
466
|
+
| DELETE | `/api/v1/apps/{app_id}/limit` | [`g8.api.apps.clearAppLimit`](apps.md#op-clearapplimit) | destructive |
|
|
467
|
+
| GET | `/api/v1/apps/{app_id}/limit` | [`g8.api.apps.getAppLimit`](apps.md#op-getapplimit) or `g8.apps.getLimit()` | read |
|
|
468
|
+
| PUT | `/api/v1/apps/{app_id}/limit` | [`g8.api.apps.setAppLimit`](apps.md#op-setapplimit) | write |
|
|
469
|
+
| GET | `/api/v1/apps/{app_id}/logs` | [`g8.api.appLogs.getAppLogs`](appLogs.md#op-getapplogs) or `g8.appPlatform.logs()` | read |
|
|
470
|
+
| POST | `/api/v1/apps/{app_id}/manifest` | [`g8.api.apps.applyAppManifest`](apps.md#op-applyappmanifest) | write |
|
|
471
|
+
| GET | `/api/v1/apps/{app_id}/runtime` | [`g8.api.apps.getAppRuntime`](apps.md#op-getappruntime) | billable |
|
|
472
|
+
| GET | `/api/v1/apps/{app_id}/schema-versions` | [`g8.api.apps.listAppSchemaVersions`](apps.md#op-listappschemaversions) or `g8.appPlatform.listSchemaVersions()` | read |
|
|
473
|
+
| POST | `/api/v1/apps/{app_id}/schema-versions` | [`g8.api.apps.publishAppSchemaVersion`](apps.md#op-publishappschemaversion) or `g8.appPlatform.publishSchemaVersion()` | write |
|
|
474
|
+
| GET | `/api/v1/apps/{app_id}/secrets` | [`g8.api.apps.listAppSecrets`](apps.md#op-listappsecrets) or `g8.appPlatform.listSecrets()` | read |
|
|
475
|
+
| DELETE | `/api/v1/apps/{app_id}/secrets/{secret_key}` | [`g8.api.apps.deleteAppSecret`](apps.md#op-deleteappsecret) or `g8.appPlatform.deleteSecret()` | destructive |
|
|
476
|
+
| PUT | `/api/v1/apps/{app_id}/secrets/{secret_key}` | [`g8.api.apps.putAppSecret`](apps.md#op-putappsecret) or `g8.appPlatform.putSecret()` | write |
|
|
477
|
+
| DELETE | `/api/v1/apps/{app_id}/source` | [`g8.api.apps.clearAppSource`](apps.md#op-clearappsource) or `g8.appPlatform.clearSource()` | destructive |
|
|
478
|
+
| PUT | `/api/v1/apps/{app_id}/source` | [`g8.api.apps.setAppSource`](apps.md#op-setappsource) or `g8.appPlatform.setSource()` | write |
|
|
479
|
+
| POST | `/api/v1/apps/{app_id}/status` | [`g8.api.apps.setAppStatus`](apps.md#op-setappstatus) or `g8.apps.setStatus()` | write |
|
|
480
|
+
| GET | `/api/v1/apps/{app_id}/usage` | [`g8.api.apps.getAppUsage`](apps.md#op-getappusage) or `g8.apps.usage()` | read |
|
|
481
|
+
| GET | `/api/v1/audience-syncs` | [`g8.api.audienceSyncs.listAudienceSyncs`](audienceSyncs.md#op-listaudiencesyncs) or `g8.audiences.list()` | read |
|
|
482
|
+
| POST | `/api/v1/audience-syncs` | [`g8.api.audienceSyncs.createAudienceSync`](audienceSyncs.md#op-createaudiencesync) or `g8.audiences.create()` | external |
|
|
483
|
+
| GET | `/api/v1/audience-syncs/account-health` | [`g8.api.integrations.listAdAccountHealth`](integrations.md#op-listadaccounthealth) | read |
|
|
484
|
+
| GET | `/api/v1/audience-syncs/accounts` | [`g8.api.integrations.listAdAccounts`](integrations.md#op-listadaccounts) | read |
|
|
485
|
+
| GET | `/api/v1/audience-syncs/analytics/daily-trend` | [`g8.api.integrations.getAdDailyTrend`](integrations.md#op-getaddailytrend) | read |
|
|
486
|
+
| GET | `/api/v1/audience-syncs/analytics/summary` | [`g8.api.integrations.getAdAnalyticsSummary`](integrations.md#op-getadanalyticssummary) | read |
|
|
487
|
+
| POST | `/api/v1/audience-syncs/google/conversion-actions` | [`g8.api.integrations.createGoogleConversionAction`](integrations.md#op-creategoogleconversionaction) | external |
|
|
488
|
+
| GET | `/api/v1/audience-syncs/google/conversion-tracking` | [`g8.api.integrations.getGoogleConversionTracking`](integrations.md#op-getgoogleconversiontracking) | read |
|
|
489
|
+
| POST | `/api/v1/audience-syncs/google/conversions` | [`g8.api.integrations.uploadGoogleConversions`](integrations.md#op-uploadgoogleconversions) | external |
|
|
490
|
+
| GET | `/api/v1/audience-syncs/google/video-assets` | [`g8.api.integrations.listVideoAssets`](integrations.md#op-listvideoassets) | read |
|
|
491
|
+
| POST | `/api/v1/audience-syncs/google/video-assets/library` | [`g8.api.integrations.registerVideoAssetFromLibrary`](integrations.md#op-registervideoassetfromlibrary) | external |
|
|
492
|
+
| POST | `/api/v1/audience-syncs/google/video-assets/links` | [`g8.api.integrations.registerVideoAssetFromLink`](integrations.md#op-registervideoassetfromlink) | external |
|
|
493
|
+
| POST | `/api/v1/audience-syncs/google/video-assets/upload-urls` | [`g8.api.integrations.createVideoUploadUrl`](integrations.md#op-createvideouploadurl) | external |
|
|
494
|
+
| POST | `/api/v1/audience-syncs/google/video-assets/uploads` | [`g8.api.integrations.registerUploadedVideoAsset`](integrations.md#op-registeruploadedvideoasset) | external |
|
|
495
|
+
| GET | `/api/v1/audience-syncs/google/video-assets/{asset_id}` | [`g8.api.integrations.getVideoAsset`](integrations.md#op-getvideoasset) | read |
|
|
496
|
+
| GET | `/api/v1/audience-syncs/platforms` | [`g8.api.integrations.listAdPlatforms`](integrations.md#op-listadplatforms) | read |
|
|
497
|
+
| DELETE | `/api/v1/audience-syncs/{config_id}` | [`g8.api.audienceSyncs.deleteAudienceSync`](audienceSyncs.md#op-deleteaudiencesync) or `g8.audiences.delete()` | destructive |
|
|
498
|
+
| GET | `/api/v1/audience-syncs/{config_id}` | [`g8.api.audienceSyncs.getAudienceSync`](audienceSyncs.md#op-getaudiencesync) or `g8.audiences.get()` | read |
|
|
499
|
+
| PATCH | `/api/v1/audience-syncs/{config_id}` | [`g8.api.audienceSyncs.updateAudienceSync`](audienceSyncs.md#op-updateaudiencesync) or `g8.audiences.update()` | external |
|
|
500
|
+
| GET | `/api/v1/audience-syncs/{config_id}/analytics` | [`g8.api.integrations.getSyncConfigAnalytics`](integrations.md#op-getsyncconfiganalytics) | read |
|
|
501
|
+
| DELETE | `/api/v1/audience-syncs/{config_id}/draft` | [`g8.api.integrations.discardDraftSyncConfig`](integrations.md#op-discarddraftsyncconfig) | destructive |
|
|
502
|
+
| GET | `/api/v1/audience-syncs/{config_id}/errors` | [`g8.api.audienceSyncs.listSyncErrors`](audienceSyncs.md#op-listsyncerrors) or `g8.audiences.errors()` | read |
|
|
503
|
+
| POST | `/api/v1/audience-syncs/{config_id}/launch` | [`g8.api.adCampaigns.launchAdCampaign`](adCampaigns.md#op-launchadcampaign) | external |
|
|
504
|
+
| GET | `/api/v1/audience-syncs/{config_id}/runs` | [`g8.api.audienceSyncs.listSyncRuns`](audienceSyncs.md#op-listsyncruns) or `g8.audiences.runs()` | billable |
|
|
505
|
+
| GET | `/api/v1/audience-syncs/{config_id}/segment-status` | [`g8.api.integrations.getSyncSegmentStatus`](integrations.md#op-getsyncsegmentstatus) | read |
|
|
506
|
+
| POST | `/api/v1/audience-syncs/{config_id}/trigger` | [`g8.api.audienceSyncs.triggerAudienceSync`](audienceSyncs.md#op-triggeraudiencesync) or `g8.audiences.trigger()` | external |
|
|
507
|
+
| GET | `/api/v1/billing/products` | [`g8.api.usage.listBillingProducts`](usage.md#op-listbillingproducts) | read |
|
|
508
|
+
| GET | `/api/v1/billing/products/{product_id}` | [`g8.api.usage.getBillingProduct`](usage.md#op-getbillingproduct) | read |
|
|
509
|
+
| GET | `/api/v1/brand-kit` | [`g8.api.brandKit.getBrandKitOverview`](brandKit.md#op-getbrandkitoverview) | read |
|
|
510
|
+
| GET | `/api/v1/brand-kit/archetypes` | [`g8.api.brandKit.listArchetypes`](brandKit.md#op-listarchetypes) | read |
|
|
511
|
+
| POST | `/api/v1/brand-kit/extract` | [`g8.api.brandKit.triggerBrandExtraction`](brandKit.md#op-triggerbrandextraction) | write |
|
|
512
|
+
| GET | `/api/v1/brand-kit/homepage` | [`g8.api.brandKit.getBrandKitHomepage`](brandKit.md#op-getbrandkithomepage) | read |
|
|
513
|
+
| POST | `/api/v1/brand-kit/homepage/recapture` | [`g8.api.brandKit.recaptureHomepageHtml`](brandKit.md#op-recapturehomepagehtml) | write |
|
|
514
|
+
| GET | `/api/v1/brand-kit/layout-selections` | [`g8.api.brandKit.getLayoutSelections`](brandKit.md#op-getlayoutselections) | read |
|
|
515
|
+
| PUT | `/api/v1/brand-kit/layout-selections` | [`g8.api.brandKit.saveLayoutSelections`](brandKit.md#op-savelayoutselections) | write |
|
|
516
|
+
| GET | `/api/v1/brand-kit/layout-templates/custom` | [`g8.api.brandKit.listCustomLayoutTemplates`](brandKit.md#op-listcustomlayouttemplates) | read |
|
|
517
|
+
| POST | `/api/v1/brand-kit/layout-templates/custom` | [`g8.api.brandKit.createCustomLayoutTemplate`](brandKit.md#op-createcustomlayouttemplate) | write |
|
|
518
|
+
| POST | `/api/v1/brand-kit/layout-templates/custom/plan` | [`g8.api.brandKit.planCustomTemplate`](brandKit.md#op-plancustomtemplate) | write |
|
|
519
|
+
| POST | `/api/v1/brand-kit/layout-templates/custom/{landing_page_id}/regenerate` | [`g8.api.brandKit.regenerateCustomLayoutTemplate`](brandKit.md#op-regeneratecustomlayouttemplate) | write |
|
|
520
|
+
| POST | `/api/v1/brand-kit/layout-templates/improve-idea` | [`g8.api.brandKit.improveCustomTemplateIdea`](brandKit.md#op-improvecustomtemplateidea) | write |
|
|
521
|
+
| POST | `/api/v1/brand-kit/layout-templates/regenerate` | [`g8.api.brandKit.regenerateLayoutTemplates`](brandKit.md#op-regeneratelayouttemplates) | write |
|
|
522
|
+
| GET | `/api/v1/brand-kit/layout-templates/status` | [`g8.api.brandKit.getLayoutTemplatesStatus`](brandKit.md#op-getlayouttemplatesstatus) | read |
|
|
523
|
+
| GET | `/api/v1/brand-kit/newsletter-archetypes` | [`g8.api.brandKit.listNewsletterArchetypes`](brandKit.md#op-listnewsletterarchetypes) | read |
|
|
524
|
+
| GET | `/api/v1/brand-kit/newsletter-selections` | [`g8.api.brandKit.getNewsletterSelections`](brandKit.md#op-getnewsletterselections) | read |
|
|
525
|
+
| PUT | `/api/v1/brand-kit/newsletter-selections` | [`g8.api.brandKit.saveNewsletterSelections`](brandKit.md#op-savenewsletterselections) | write |
|
|
526
|
+
| GET | `/api/v1/brand-kit/newsletter-templates` | [`g8.api.brandKit.listNewsletterTemplates`](brandKit.md#op-listnewslettertemplates) | read |
|
|
527
|
+
| POST | `/api/v1/brand-kit/newsletter-templates/regenerate` | [`g8.api.brandKit.regenerateNewsletterTemplates`](brandKit.md#op-regeneratenewslettertemplates) | write |
|
|
528
|
+
| GET | `/api/v1/brand-kit/newsletter-templates/status` | [`g8.api.brandKit.getNewsletterTemplatesStatus`](brandKit.md#op-getnewslettertemplatesstatus) | read |
|
|
529
|
+
| GET | `/api/v1/brand-kit/section-library` | [`g8.api.brandKit.getSectionLibrary`](brandKit.md#op-getsectionlibrary) | read |
|
|
530
|
+
| GET | `/api/v1/brand-kit/section-library/candidate-pages` | [`g8.api.brandKit.listCandidatePagesForSectionLibrary`](brandKit.md#op-listcandidatepagesforsectionlibrary) | read |
|
|
531
|
+
| POST | `/api/v1/brand-kit/section-library/rebuild` | [`g8.api.brandKit.rebuildSectionLibrary`](brandKit.md#op-rebuildsectionlibrary) | write |
|
|
532
|
+
| GET | `/api/v1/brand-kit/section-library/{section_id}` | [`g8.api.brandKit.getSectionLibraryItem`](brandKit.md#op-getsectionlibraryitem) | read |
|
|
533
|
+
| GET | `/api/v1/brand-kit/section-tag-overrides` | [`g8.api.brandKit.getSectionTagOverrides`](brandKit.md#op-getsectiontagoverrides) | read |
|
|
534
|
+
| PUT | `/api/v1/brand-kit/section-tag-overrides` | [`g8.api.brandKit.saveSectionTagOverrides`](brandKit.md#op-savesectiontagoverrides) | write |
|
|
535
|
+
| GET | `/api/v1/brand-kit/sections` | [`g8.api.brandKit.getHomepageSections`](brandKit.md#op-gethomepagesections) | read |
|
|
536
|
+
| DELETE | `/api/v1/brand-kit/templates` | [`g8.api.brandKit.deleteBrandKitTemplates`](brandKit.md#op-deletebrandkittemplates) | destructive |
|
|
537
|
+
| GET | `/api/v1/brand-kit/templates` | [`g8.api.brandKit.getBrandKitTemplates`](brandKit.md#op-getbrandkittemplates) | read |
|
|
538
|
+
| GET | `/api/v1/brand-kit/templates/status` | [`g8.api.brandKit.getTemplateGenerationStatus`](brandKit.md#op-gettemplategenerationstatus) | read |
|
|
539
|
+
| GET | `/api/v1/bug-reports` | [`g8.api.bugReports.listBugReports`](bugReports.md#op-listbugreports) | read |
|
|
540
|
+
| POST | `/api/v1/bug-reports` | [`g8.api.bugReports.createBugReport`](bugReports.md#op-createbugreport) | write |
|
|
541
|
+
| GET | `/api/v1/bug-reports/board` | [`g8.api.bugReports.getBugBoard`](bugReports.md#op-getbugboard) | read |
|
|
542
|
+
| GET | `/api/v1/bug-reports/{report_id}` | [`g8.api.bugReports.getBugReport`](bugReports.md#op-getbugreport) | read |
|
|
543
|
+
| POST | `/api/v1/bug-reports/{report_id}/close` | [`g8.api.bugReports.closeBugReport`](bugReports.md#op-closebugreport) | write |
|
|
544
|
+
| POST | `/api/v1/bug-reports/{report_id}/comments` | [`g8.api.bugReports.commentOnBugReport`](bugReports.md#op-commentonbugreport) | write |
|
|
545
|
+
| GET | `/api/v1/bug-reports/{report_id}/screenshots` | [`g8.api.bugReports.getBugReportScreenshots`](bugReports.md#op-getbugreportscreenshots) | read |
|
|
546
|
+
| POST | `/api/v1/calendar-invites` | [`g8.api.calendarInvites.createCalendarInvite`](calendarInvites.md#op-createcalendarinvite) | write |
|
|
547
|
+
| GET | `/api/v1/calendar-invites/{invite_id}` | [`g8.api.calendarInvites.getCalendarInvite`](calendarInvites.md#op-getcalendarinvite) | read |
|
|
548
|
+
| PATCH | `/api/v1/calendar-invites/{invite_id}` | [`g8.api.calendarInvites.updateCalendarInvite`](calendarInvites.md#op-updatecalendarinvite) | write |
|
|
549
|
+
| GET | `/api/v1/campaigns` | [`g8.api.gtmCampaigns.listCampaigns`](gtmCampaigns.md#op-listcampaigns) or `g8.campaigns.list()` | read |
|
|
550
|
+
| POST | `/api/v1/campaigns` | [`g8.api.gtmCampaigns.createCampaign`](gtmCampaigns.md#op-createcampaign) or `g8.campaigns.create()` | external |
|
|
551
|
+
| GET | `/api/v1/campaigns/audience-lists/options` | [`g8.api.campaigns.listCampaignAudienceListOptions`](campaigns.md#op-listcampaignaudiencelistoptions) | read |
|
|
552
|
+
| POST | `/api/v1/campaigns/audience-profile/preview` | [`g8.api.campaigns.previewCampaignAudienceProfile`](campaigns.md#op-previewcampaignaudienceprofile) | read |
|
|
553
|
+
| POST | `/api/v1/campaigns/document-manifest/preview` | [`g8.api.campaigns.previewCampaignDocumentManifest`](campaigns.md#op-previewcampaigndocumentmanifest) | read |
|
|
554
|
+
| POST | `/api/v1/campaigns/generate-ideas` | [`g8.api.campaigns.generateCampaignIdeas`](campaigns.md#op-generatecampaignideas) | billable |
|
|
555
|
+
| POST | `/api/v1/campaigns/generate-ideas-async` | [`g8.api.campaigns.generateCampaignIdeasAsync`](campaigns.md#op-generatecampaignideasasync) | billable |
|
|
556
|
+
| GET | `/api/v1/campaigns/generation-options` | [`g8.api.campaigns.getCampaignGenerationOptions`](campaigns.md#op-getcampaigngenerationoptions) | read |
|
|
557
|
+
| GET | `/api/v1/campaigns/ideas` | [`g8.api.gtmCampaigns.listCampaignIdeas`](gtmCampaigns.md#op-listcampaignideas) | read |
|
|
558
|
+
| POST | `/api/v1/campaigns/ideas/manual` | [`g8.api.campaigns.createManualCampaignIdea`](campaigns.md#op-createmanualcampaignidea) | write |
|
|
559
|
+
| POST | `/api/v1/campaigns/ideas/save` | [`g8.api.campaignWorkflows.saveCampaignIdeas`](campaignWorkflows.md#op-savecampaignideas) | write |
|
|
560
|
+
| GET | `/api/v1/campaigns/ideas/status/{task_id}` | [`g8.api.campaigns.getCampaignIdeasTaskStatus`](campaigns.md#op-getcampaignideastaskstatus) | read |
|
|
561
|
+
| DELETE | `/api/v1/campaigns/ideas/{idea_id}` | [`g8.api.campaigns.deleteCampaignIdea`](campaigns.md#op-deletecampaignidea) | destructive |
|
|
562
|
+
| PATCH | `/api/v1/campaigns/ideas/{idea_id}` | [`g8.api.campaigns.updateCampaignIdea`](campaigns.md#op-updatecampaignidea) | write |
|
|
563
|
+
| POST | `/api/v1/campaigns/ideas/{idea_id}/archive` | [`g8.api.campaigns.archiveCampaignIdea`](campaigns.md#op-archivecampaignidea) | write |
|
|
564
|
+
| POST | `/api/v1/campaigns/ideas/{idea_id}/favorite` | [`g8.api.campaigns.toggleCampaignIdeaFavorite`](campaigns.md#op-togglecampaignideafavorite) | write |
|
|
565
|
+
| GET | `/api/v1/campaigns/picker` | [`g8.api.campaigns.listCampaignsForPicker`](campaigns.md#op-listcampaignsforpicker) | read |
|
|
566
|
+
| POST | `/api/v1/campaigns/recommend-personas` | [`g8.api.campaigns.recommendCampaignPersonas`](campaigns.md#op-recommendcampaignpersonas) | billable |
|
|
567
|
+
| POST | `/api/v1/campaigns/suggest` | [`g8.api.campaigns.suggestCampaignConcepts`](campaigns.md#op-suggestcampaignconcepts) | read |
|
|
568
|
+
| DELETE | `/api/v1/campaigns/{campaign_id}` | [`g8.api.campaigns.deleteCampaign`](campaigns.md#op-deletecampaign) | destructive |
|
|
569
|
+
| GET | `/api/v1/campaigns/{campaign_id}` | [`g8.api.gtmCampaigns.getCampaign`](gtmCampaigns.md#op-getcampaign) or `g8.campaigns.get()` | read |
|
|
570
|
+
| PATCH | `/api/v1/campaigns/{campaign_id}` | [`g8.api.gtmCampaigns.updateCampaign`](gtmCampaigns.md#op-updatecampaign) | external |
|
|
571
|
+
| GET | `/api/v1/campaigns/{campaign_id}/ad-images` | [`g8.api.gtmCampaigns.listCampaignAdImages`](gtmCampaigns.md#op-listcampaignadimages) | read |
|
|
572
|
+
| POST | `/api/v1/campaigns/{campaign_id}/ad-images/{image_id}/hide` | [`g8.api.gtmCampaigns.hideCampaignAdImage`](gtmCampaigns.md#op-hidecampaignadimage) | external |
|
|
573
|
+
| PUT | `/api/v1/campaigns/{campaign_id}/audience` | [`g8.api.gtmCampaigns.attachAudienceToCampaign`](gtmCampaigns.md#op-attachaudiencetocampaign) | external |
|
|
574
|
+
| POST | `/api/v1/campaigns/{campaign_id}/audience-pipeline/accept-filters` | [`g8.api.campaigns.acceptAudiencePipelineFilters`](campaigns.md#op-acceptaudiencepipelinefilters) | billable |
|
|
575
|
+
| GET | `/api/v1/campaigns/{campaign_id}/audience-pipeline/status` | [`g8.api.campaigns.getAudiencePipelineStatus`](campaigns.md#op-getaudiencepipelinestatus) | read |
|
|
576
|
+
| GET | `/api/v1/campaigns/{campaign_id}/audience-pipeline/suggested-filters` | [`g8.api.campaigns.getAudiencePipelineSuggestedFilters`](campaigns.md#op-getaudiencepipelinesuggestedfilters) | read |
|
|
577
|
+
| POST | `/api/v1/campaigns/{campaign_id}/audience-pipeline/trigger` | [`g8.api.campaigns.triggerAudiencePipeline`](campaigns.md#op-triggeraudiencepipeline) | billable |
|
|
578
|
+
| GET | `/api/v1/campaigns/{campaign_id}/dashboard` | [`g8.api.campaigns.getCampaignDashboard`](campaigns.md#op-getcampaigndashboard) | billable |
|
|
579
|
+
| GET | `/api/v1/campaigns/{campaign_id}/documents` | [`g8.api.gtmCampaigns.listCampaignDocuments`](gtmCampaigns.md#op-listcampaigndocuments) | read |
|
|
580
|
+
| POST | `/api/v1/campaigns/{campaign_id}/documents` | [`g8.api.gtmCampaigns.createCampaignDocument`](gtmCampaigns.md#op-createcampaigndocument) | external |
|
|
581
|
+
| DELETE | `/api/v1/campaigns/{campaign_id}/documents/{document_id}` | [`g8.api.gtmCampaigns.deleteCampaignDocument`](gtmCampaigns.md#op-deletecampaigndocument) | destructive |
|
|
582
|
+
| GET | `/api/v1/campaigns/{campaign_id}/documents/{document_id}` | [`g8.api.gtmCampaigns.getCampaignDocument`](gtmCampaigns.md#op-getcampaigndocument) | read |
|
|
583
|
+
| PUT | `/api/v1/campaigns/{campaign_id}/documents/{document_id}` | [`g8.api.gtmCampaigns.updateCampaignDocument`](gtmCampaigns.md#op-updatecampaigndocument) | external |
|
|
584
|
+
| POST | `/api/v1/campaigns/{campaign_id}/documents/{document_id}/regenerate` | [`g8.api.campaigns.regenerateCampaignDocument`](campaigns.md#op-regeneratecampaigndocument) | billable |
|
|
585
|
+
| GET | `/api/v1/campaigns/{campaign_id}/files` | [`g8.api.campaigns.listCampaignGeneratedFiles`](campaigns.md#op-listcampaigngeneratedfiles) | read |
|
|
586
|
+
| GET | `/api/v1/campaigns/{campaign_id}/files/{file_type}` | [`g8.api.campaigns.getCampaignGeneratedFile`](campaigns.md#op-getcampaigngeneratedfile) | read |
|
|
587
|
+
| GET | `/api/v1/campaigns/{campaign_id}/full` | [`g8.api.gtmCampaigns.getCampaignFull`](gtmCampaigns.md#op-getcampaignfull) | read |
|
|
588
|
+
| PATCH | `/api/v1/campaigns/{campaign_id}/full` | [`g8.api.gtmCampaigns.patchCampaignFull`](gtmCampaigns.md#op-patchcampaignfull) | external |
|
|
589
|
+
| GET | `/api/v1/campaigns/{campaign_id}/generation-progress` | [`g8.api.campaignWorkflows.getCampaignGenerationProgress`](campaignWorkflows.md#op-getcampaigngenerationprogress) | read |
|
|
590
|
+
| GET | `/api/v1/campaigns/{campaign_id}/landing-pages` | [`g8.api.campaigns.listCampaignLandingPages`](campaigns.md#op-listcampaignlandingpages) | read |
|
|
591
|
+
| POST | `/api/v1/campaigns/{campaign_id}/landing-pages` | [`g8.api.campaigns.linkLandingPageToCampaign`](campaigns.md#op-linklandingpagetocampaign) | write |
|
|
592
|
+
| DELETE | `/api/v1/campaigns/{campaign_id}/landing-pages/{landing_page_id}` | [`g8.api.campaigns.unlinkLandingPageFromCampaign`](campaigns.md#op-unlinklandingpagefromcampaign) | destructive |
|
|
593
|
+
| POST | `/api/v1/campaigns/{campaign_id}/launch` | [`g8.api.gtmCampaigns.launchCampaign`](gtmCampaigns.md#op-launchcampaign) or `g8.campaigns.launch()` | external |
|
|
594
|
+
| GET | `/api/v1/campaigns/{campaign_id}/metrics` | [`g8.api.gtmCampaigns.getCampaignMetrics`](gtmCampaigns.md#op-getcampaignmetrics) | read |
|
|
595
|
+
| GET | `/api/v1/campaigns/{campaign_id}/sequence` | [`g8.api.gtmCampaigns.getCampaignSequence`](gtmCampaigns.md#op-getcampaignsequence) | read |
|
|
596
|
+
| PUT | `/api/v1/campaigns/{campaign_id}/sequence` | [`g8.api.gtmCampaigns.updateCampaignSequence`](gtmCampaigns.md#op-updatecampaignsequence) | external |
|
|
597
|
+
| POST | `/api/v1/campaigns/{campaign_id}/sequence/steps` | [`g8.api.gtmCampaigns.createCampaignStep`](gtmCampaigns.md#op-createcampaignstep) | external |
|
|
598
|
+
| DELETE | `/api/v1/campaigns/{campaign_id}/sequence/steps/{step_id}` | [`g8.api.gtmCampaigns.deleteCampaignStep`](gtmCampaigns.md#op-deletecampaignstep) | destructive |
|
|
599
|
+
| PUT | `/api/v1/campaigns/{campaign_id}/sequence/steps/{step_id}` | [`g8.api.gtmCampaigns.updateCampaignStep`](gtmCampaigns.md#op-updatecampaignstep) | external |
|
|
600
|
+
| POST | `/api/v1/campaigns/{campaign_id}/sequence/steps/{step_id}/generate` | [`g8.api.campaigns.generateCampaignStepContent`](campaigns.md#op-generatecampaignstepcontent) | billable |
|
|
601
|
+
| GET | `/api/v1/campaigns/{campaign_id}/status` | [`g8.api.campaigns.getCampaignGenerationStatus`](campaigns.md#op-getcampaigngenerationstatus) | read |
|
|
602
|
+
| GET | `/api/v1/campaigns/{campaign_id}/workflows` | [`g8.api.campaignWorkflows.listCampaignWorkflows`](campaignWorkflows.md#op-listcampaignworkflows) | read |
|
|
603
|
+
| DELETE | `/api/v1/campaigns/{campaign_id}/workflows/{link_id}` | [`g8.api.campaignWorkflows.unlinkCampaignWorkflow`](campaignWorkflows.md#op-unlinkcampaignworkflow) | destructive |
|
|
604
|
+
| PUT | `/api/v1/campaigns/{campaign_id}/workflows/{link_id}` | [`g8.api.campaignWorkflows.updateCampaignWorkflowLink`](campaignWorkflows.md#op-updatecampaignworkflowlink) | write |
|
|
605
|
+
| GET | `/api/v1/channels/preferences` | [`g8.api.channels.getChannelPreferences`](channels.md#op-getchannelpreferences) | read |
|
|
606
|
+
| PUT | `/api/v1/channels/preferences` | [`g8.api.channels.setChannelPreference`](channels.md#op-setchannelpreference) | write |
|
|
607
|
+
| POST | `/api/v1/clickhouse/mashup` | [`g8.api.clickHouse.clickhouseMashup`](clickHouse.md#op-clickhousemashup) | write |
|
|
608
|
+
| POST | `/api/v1/clickhouse/org-analytics` | [`g8.api.clickHouse.clickhouseOrgAnalytics`](clickHouse.md#op-clickhouseorganalytics) | write |
|
|
609
|
+
| GET | `/api/v1/committees` | [`g8.api.gtmLibrary.listCommittees`](gtmLibrary.md#op-listcommittees) | read |
|
|
610
|
+
| POST | `/api/v1/committees` | [`g8.api.gtmLibrary.createCommittee`](gtmLibrary.md#op-createcommittee) | write |
|
|
611
|
+
| DELETE | `/api/v1/committees/{committee_id}` | [`g8.api.gtmLibrary.deleteCommittee`](gtmLibrary.md#op-deletecommittee) | destructive |
|
|
612
|
+
| GET | `/api/v1/committees/{committee_id}` | [`g8.api.gtmLibrary.getCommittee`](gtmLibrary.md#op-getcommittee) | read |
|
|
613
|
+
| PATCH | `/api/v1/committees/{committee_id}` | [`g8.api.gtmLibrary.updateCommittee`](gtmLibrary.md#op-updatecommittee) | write |
|
|
614
|
+
| PUT | `/api/v1/committees/{committee_id}/members` | [`g8.api.gtmLibrary.replaceCommitteeMembers`](gtmLibrary.md#op-replacecommitteemembers) | write |
|
|
615
|
+
| GET | `/api/v1/companies` | [`g8.api.companies.listCompanies`](companies.md#op-listcompanies) or `g8.companies.list()` | read |
|
|
616
|
+
| POST | `/api/v1/companies` | [`g8.api.companies.createCompany`](companies.md#op-createcompany) or `g8.companies.create()` | write |
|
|
617
|
+
| PUT | `/api/v1/companies/assert` | [`g8.api.assertUpsert.assertCompany`](assertUpsert.md#op-assertcompany) | write |
|
|
618
|
+
| PUT | `/api/v1/companies/assert/batch` | [`g8.api.assertUpsert.assertCompaniesBatch`](assertUpsert.md#op-assertcompaniesbatch) | write |
|
|
619
|
+
| POST | `/api/v1/companies/assign-owner` | [`g8.api.companies.assignCompanyOwner`](companies.md#op-assigncompanyowner) | write |
|
|
620
|
+
| GET | `/api/v1/companies/columns` | [`g8.api.companies.listCompanyColumns`](companies.md#op-listcompanycolumns) or `g8.companies.listColumns()` | read |
|
|
621
|
+
| POST | `/api/v1/companies/columns/create` | [`g8.api.companies.createCompanyColumn`](companies.md#op-createcompanycolumn) or `g8.companies.createColumn()` | write |
|
|
622
|
+
| DELETE | `/api/v1/companies/columns/{column_id}` | [`g8.api.companies.deleteCompanyColumn`](companies.md#op-deletecompanycolumn) | destructive |
|
|
623
|
+
| GET | `/api/v1/companies/contacts` | [`g8.api.companies.listContactsAcrossCompanies`](companies.md#op-listcontactsacrosscompanies) | read |
|
|
624
|
+
| POST | `/api/v1/companies/enrich/bulk` | [`g8.api.companies.bulkEnrichCompanies`](companies.md#op-bulkenrichcompanies) | billable |
|
|
625
|
+
| POST | `/api/v1/companies/enrich/people/bulk` | [`g8.api.companies.bulkEnrichCompanyPeople`](companies.md#op-bulkenrichcompanypeople) | billable |
|
|
626
|
+
| POST | `/api/v1/companies/enrich/stakeholders/bulk` | [`g8.api.companies.bulkEnrichCompanyStakeholders`](companies.md#op-bulkenrichcompanystakeholders) | billable |
|
|
627
|
+
| GET | `/api/v1/companies/enriched` | [`g8.api.companies.listCompaniesEnriched`](companies.md#op-listcompaniesenriched) | read |
|
|
628
|
+
| GET | `/api/v1/companies/form-fields` | [`g8.api.companies.getCompanyFormFields`](companies.md#op-getcompanyformfields) | read |
|
|
629
|
+
| POST | `/api/v1/companies/import` | [`g8.api.companies.importCompanies`](companies.md#op-importcompanies) | billable |
|
|
630
|
+
| POST | `/api/v1/companies/merge-filtered` | [`g8.api.companies.mergeFilteredCompanies`](companies.md#op-mergefilteredcompanies) | write |
|
|
631
|
+
| POST | `/api/v1/companies/open-jobs` | [`g8.api.companies.getCompaniesOpenJobs`](companies.md#op-getcompaniesopenjobs) | read |
|
|
632
|
+
| GET | `/api/v1/companies/review-stats` | [`g8.api.companies.getCompanyReviewStats`](companies.md#op-getcompanyreviewstats) | read |
|
|
633
|
+
| DELETE | `/api/v1/companies/{company_id}` | [`g8.api.companies.deleteCompany`](companies.md#op-deletecompany) or `g8.companies.delete()` | destructive |
|
|
634
|
+
| GET | `/api/v1/companies/{company_id}` | [`g8.api.companies.getCompany`](companies.md#op-getcompany) or `g8.companies.get()` | read |
|
|
635
|
+
| PATCH | `/api/v1/companies/{company_id}` | [`g8.api.companies.updateCompany`](companies.md#op-updatecompany) or `g8.companies.update()` | write |
|
|
636
|
+
| GET | `/api/v1/companies/{company_id}/activities` | [`g8.api.revenueRecords.listCompanyActivities`](revenueRecords.md#op-listcompanyactivities) | read |
|
|
637
|
+
| GET | `/api/v1/companies/{company_id}/billing` | [`g8.api.usage.getCompanyBilling`](usage.md#op-getcompanybilling) | read |
|
|
638
|
+
| GET | `/api/v1/companies/{company_id}/billing-prefill` | [`g8.api.companies.getCompanyBillingPrefill`](companies.md#op-getcompanybillingprefill) | read |
|
|
639
|
+
| POST | `/api/v1/companies/{company_id}/billing-prefill/refresh` | [`g8.api.companies.refreshCompanyBillingPrefill`](companies.md#op-refreshcompanybillingprefill) | write |
|
|
640
|
+
| GET | `/api/v1/companies/{company_id}/contacts` | [`g8.api.companies.getCompanyContacts`](companies.md#op-getcompanycontacts) or `g8.companies.contacts()` | read |
|
|
641
|
+
| DELETE | `/api/v1/companies/{company_id}/contacts/{contact_id}` | [`g8.api.companies.removeCompanyContact`](companies.md#op-removecompanycontact) | destructive |
|
|
642
|
+
| POST | `/api/v1/companies/{company_id}/contacts/{contact_id}` | [`g8.api.companies.attachCompanyContact`](companies.md#op-attachcompanycontact) | write |
|
|
643
|
+
| GET | `/api/v1/companies/{company_id}/dashboard` | [`g8.api.companies.getCompanyDashboard`](companies.md#op-getcompanydashboard) | read |
|
|
644
|
+
| GET | `/api/v1/companies/{company_id}/deals` | [`g8.api.deals.getCompanyDeals`](deals.md#op-getcompanydeals) or `g8.deals.forCompany()` | read |
|
|
645
|
+
| GET | `/api/v1/companies/{company_id}/detail` | [`g8.api.companies.getCompanyDetail`](companies.md#op-getcompanydetail) | read |
|
|
646
|
+
| GET | `/api/v1/companies/{company_id}/documents` | [`g8.api.companies.listCompanyDocuments`](companies.md#op-listcompanydocuments) | read |
|
|
647
|
+
| POST | `/api/v1/companies/{company_id}/documents/from-skill` | [`g8.api.companies.saveSkillResultToCompany`](companies.md#op-saveskillresulttocompany) | write |
|
|
648
|
+
| POST | `/api/v1/companies/{company_id}/documents/types/{doc_type}/generate` | [`g8.api.companies.generateCompanyDocument`](companies.md#op-generatecompanydocument) | billable |
|
|
649
|
+
| POST | `/api/v1/companies/{company_id}/documents/types/{doc_type}/regenerate` | [`g8.api.companies.regenerateCompanyDocument`](companies.md#op-regeneratecompanydocument) | billable |
|
|
650
|
+
| DELETE | `/api/v1/companies/{company_id}/documents/{document_id}` | [`g8.api.companies.deleteCompanyDocument`](companies.md#op-deletecompanydocument) | destructive |
|
|
651
|
+
| GET | `/api/v1/companies/{company_id}/engagement-summary` | [`g8.api.companies.getCompanyEngagementSummary`](companies.md#op-getcompanyengagementsummary) | read |
|
|
652
|
+
| POST | `/api/v1/companies/{company_id}/enrich` | [`g8.api.companies.enrichCompany`](companies.md#op-enrichcompany) | billable |
|
|
653
|
+
| GET | `/api/v1/companies/{company_id}/events` | [`g8.api.revenueRecords.getCompanyEvents`](revenueRecords.md#op-getcompanyevents) | read |
|
|
654
|
+
| GET | `/api/v1/companies/{company_id}/icp-fit` | [`g8.api.companies.getCompanyIcpFit`](companies.md#op-getcompanyicpfit) | read |
|
|
655
|
+
| GET | `/api/v1/companies/{company_id}/intelligence-data/{data_type}` | [`g8.api.companies.getCompanyIntelligenceData`](companies.md#op-getcompanyintelligencedata) | read |
|
|
656
|
+
| GET | `/api/v1/companies/{company_id}/intelligence-status` | [`g8.api.companies.getCompanyIntelligenceStatus`](companies.md#op-getcompanyintelligencestatus) | read |
|
|
657
|
+
| GET | `/api/v1/companies/{company_id}/intelligence-steps` | [`g8.api.companies.getCompanyIntelligenceSteps`](companies.md#op-getcompanyintelligencesteps) | read |
|
|
658
|
+
| GET | `/api/v1/companies/{company_id}/lifecycle-snapshot` | [`g8.api.revenueRecords.getCompanyLifecycleSnapshot`](revenueRecords.md#op-getcompanylifecyclesnapshot) | read |
|
|
659
|
+
| POST | `/api/v1/companies/{company_id}/lifecycle-stage` | [`g8.api.revenueLifecycle.moveCompanyLifecycleStage`](revenueLifecycle.md#op-movecompanylifecyclestage) | write |
|
|
660
|
+
| POST | `/api/v1/companies/{company_id}/merge` | [`g8.api.companies.mergeCompany`](companies.md#op-mergecompany) | destructive |
|
|
661
|
+
| GET | `/api/v1/companies/{company_id}/merge/preview` | [`g8.api.companies.previewCompanyMerge`](companies.md#op-previewcompanymerge) | read |
|
|
662
|
+
| GET | `/api/v1/companies/{company_id}/next-best-step` | [`g8.api.companies.getCompanyNextBestStep`](companies.md#op-getcompanynextbeststep) | billable |
|
|
663
|
+
| GET | `/api/v1/companies/{company_id}/notes` | [`g8.api.notes.listCompanyNotes`](notes.md#op-listcompanynotes) or `g8.notes.listForCompany()` | read |
|
|
664
|
+
| POST | `/api/v1/companies/{company_id}/notes` | [`g8.api.notes.createCompanyNote`](notes.md#op-createcompanynote) or `g8.notes.createForCompany()` | write |
|
|
665
|
+
| GET | `/api/v1/companies/{company_id}/people` | [`g8.api.companies.listCompanyPeople`](companies.md#op-listcompanypeople) | read |
|
|
666
|
+
| GET | `/api/v1/companies/{company_id}/quotes` | [`g8.api.quotes.getCompanyQuotes`](quotes.md#op-getcompanyquotes) or `g8.quotes.forCompany()` | read |
|
|
667
|
+
| POST | `/api/v1/companies/{company_id}/retry-intelligence` | [`g8.api.companies.retryCompanyIntelligence`](companies.md#op-retrycompanyintelligence) | billable |
|
|
668
|
+
| POST | `/api/v1/companies/{company_id}/retry-synthesis` | [`g8.api.companies.retryCompanySynthesis`](companies.md#op-retrycompanysynthesis) | billable |
|
|
669
|
+
| GET | `/api/v1/companies/{company_id}/signals` | [`g8.api.companies.getCompanySignals`](companies.md#op-getcompanysignals) | read |
|
|
670
|
+
| GET | `/api/v1/companies/{company_id}/sites-visited` | [`g8.api.companies.getCompanySitesVisited`](companies.md#op-getcompanysitesvisited) | read |
|
|
671
|
+
| GET | `/api/v1/companies/{company_id}/synthesis-readiness` | [`g8.api.companies.getCompanySynthesisReadiness`](companies.md#op-getcompanysynthesisreadiness) | read |
|
|
672
|
+
| GET | `/api/v1/companies/{company_id}/tasks` | [`g8.api.companies.listCompanyTasks`](companies.md#op-listcompanytasks) | read |
|
|
673
|
+
| POST | `/api/v1/companies/{company_id}/tasks` | [`g8.api.companies.createCompanyTask`](companies.md#op-createcompanytask) | write |
|
|
674
|
+
| GET | `/api/v1/companies/{company_id}/workflow-status` | [`g8.api.companies.getCompanyWorkflowStatus`](companies.md#op-getcompanyworkflowstatus) | read |
|
|
675
|
+
| POST | `/api/v1/companies/{company_id}/workflows/{workflow_type}/start` | [`g8.api.companies.startCompanyWorkflow`](companies.md#op-startcompanyworkflow) | billable |
|
|
676
|
+
| GET | `/api/v1/company-profile` | [`g8.api.gtmContext.getCompanyProfile`](gtmContext.md#op-getcompanyprofile) | read |
|
|
677
|
+
| PUT | `/api/v1/company-profile` | [`g8.api.gtmContext.updateCompanyProfile`](gtmContext.md#op-updatecompanyprofile) | write |
|
|
678
|
+
| POST | `/api/v1/company-profile/approve` | [`g8.api.gtmContext.approveCompanyProfile`](gtmContext.md#op-approvecompanyprofile) | write |
|
|
679
|
+
| POST | `/api/v1/company-profile/generate` | [`g8.api.gtmContext.generateCompanyProfile`](gtmContext.md#op-generatecompanyprofile) | billable |
|
|
680
|
+
| DELETE | `/api/v1/company-profile/keywords` | [`g8.api.gtmContext.resetCompanyProfileKeywords`](gtmContext.md#op-resetcompanyprofilekeywords) | destructive |
|
|
681
|
+
| POST | `/api/v1/company-profile/keywords/approve` | [`g8.api.gtmContext.approveCompanyProfileKeywords`](gtmContext.md#op-approvecompanyprofilekeywords) | write |
|
|
682
|
+
| POST | `/api/v1/company-profile/logo` | [`g8.api.gtmContext.uploadCompanyProfileLogo`](gtmContext.md#op-uploadcompanyprofilelogo) | write |
|
|
683
|
+
| POST | `/api/v1/company-profile/reindex` | [`g8.api.gtmContext.reindexCompanyProfile`](gtmContext.md#op-reindexcompanyprofile) | billable |
|
|
684
|
+
| POST | `/api/v1/company-profile/retry` | [`g8.api.gtmContext.retryCompanyProfile`](gtmContext.md#op-retrycompanyprofile) | billable |
|
|
685
|
+
| POST | `/api/v1/company-profile/unapprove` | [`g8.api.gtmContext.unapproveCompanyProfile`](gtmContext.md#op-unapprovecompanyprofile) | write |
|
|
686
|
+
| GET | `/api/v1/company-profile/workflow-status` | [`g8.api.gtmContext.getCompanyProfileWorkflowStatus`](gtmContext.md#op-getcompanyprofileworkflowstatus) | read |
|
|
687
|
+
| GET | `/api/v1/contacts` | [`g8.api.contacts.listContacts`](contacts.md#op-listcontacts) or `g8.contacts.list()` | read |
|
|
688
|
+
| POST | `/api/v1/contacts` | [`g8.api.contacts.createContacts`](contacts.md#op-createcontacts) or `g8.contacts.create()` | write |
|
|
689
|
+
| PUT | `/api/v1/contacts/assert` | [`g8.api.assertUpsert.assertContact`](assertUpsert.md#op-assertcontact) or `g8.contacts.upsert()` | write |
|
|
690
|
+
| PUT | `/api/v1/contacts/assert/batch` | [`g8.api.assertUpsert.assertContactsBatch`](assertUpsert.md#op-assertcontactsbatch) | write |
|
|
691
|
+
| POST | `/api/v1/contacts/assign-owner` | [`g8.api.contacts.assignContactOwner`](contacts.md#op-assigncontactowner) | write |
|
|
692
|
+
| GET | `/api/v1/contacts/base-columns` | [`g8.api.contacts.listBaseColumns`](contacts.md#op-listbasecolumns) | read |
|
|
693
|
+
| POST | `/api/v1/contacts/bulk-get` | [`g8.api.contacts.bulkGetContacts`](contacts.md#op-bulkgetcontacts) | read |
|
|
694
|
+
| POST | `/api/v1/contacts/bulk-update` | [`g8.api.contacts.bulkUpdateContacts`](contacts.md#op-bulkupdatecontacts) | write |
|
|
695
|
+
| GET | `/api/v1/contacts/column-definitions` | [`g8.api.contacts.listContactColumnDefinitions`](contacts.md#op-listcontactcolumndefinitions) | read |
|
|
696
|
+
| GET | `/api/v1/contacts/column-names` | [`g8.api.contacts.listColumnNames`](contacts.md#op-listcolumnnames) | read |
|
|
697
|
+
| POST | `/api/v1/contacts/column-values` | [`g8.api.contacts.getRecordColumnValues`](contacts.md#op-getrecordcolumnvalues) | read |
|
|
698
|
+
| GET | `/api/v1/contacts/columns` | [`g8.api.contacts.listContactColumns`](contacts.md#op-listcontactcolumns) or `g8.contacts.listColumns()` | read |
|
|
699
|
+
| POST | `/api/v1/contacts/columns/create` | [`g8.api.contacts.createContactColumn`](contacts.md#op-createcontactcolumn) or `g8.contacts.createColumn()` | write |
|
|
700
|
+
| DELETE | `/api/v1/contacts/columns/{column_id}` | [`g8.api.contacts.deleteContactColumn`](contacts.md#op-deletecontactcolumn) | destructive |
|
|
701
|
+
| GET | `/api/v1/contacts/custom-column-definitions` | [`g8.api.contacts.listCustomColumnDefinitions`](contacts.md#op-listcustomcolumndefinitions) | read |
|
|
702
|
+
| GET | `/api/v1/contacts/dashboard-stats` | [`g8.api.contacts.getContactDashboardStats`](contacts.md#op-getcontactdashboardstats) | read |
|
|
703
|
+
| POST | `/api/v1/contacts/fetch` | [`g8.api.contacts.fetchContacts`](contacts.md#op-fetchcontacts) | read |
|
|
704
|
+
| GET | `/api/v1/contacts/form-fields` | [`g8.api.contacts.getContactFormFields`](contacts.md#op-getcontactformfields) | read |
|
|
705
|
+
| POST | `/api/v1/contacts/merge-filtered` | [`g8.api.contacts.mergeFilteredContacts`](contacts.md#op-mergefilteredcontacts) | write |
|
|
706
|
+
| POST | `/api/v1/contacts/profile-pictures` | [`g8.api.contacts.getContactProfilePictures`](contacts.md#op-getcontactprofilepictures) | read |
|
|
707
|
+
| POST | `/api/v1/contacts/related` | [`g8.api.contacts.batchContactRelated`](contacts.md#op-batchcontactrelated) | read |
|
|
708
|
+
| GET | `/api/v1/contacts/row-detail/{record_id}` | [`g8.api.contacts.getContactRowDetail`](contacts.md#op-getcontactrowdetail) | read |
|
|
709
|
+
| GET | `/api/v1/contacts/searchable-fields` | [`g8.api.contacts.listSearchableFields`](contacts.md#op-listsearchablefields) | read |
|
|
710
|
+
| GET | `/api/v1/contacts/suppressions` | [`g8.api.suppressions.listSuppressions`](suppressions.md#op-listsuppressions) | read |
|
|
711
|
+
| POST | `/api/v1/contacts/suppressions/bulk-add` | [`g8.api.suppressions.bulkAddSuppressions`](suppressions.md#op-bulkaddsuppressions) | write |
|
|
712
|
+
| POST | `/api/v1/contacts/suppressions/reinstate` | [`g8.api.suppressions.reinstateSuppressions`](suppressions.md#op-reinstatesuppressions) | write |
|
|
713
|
+
| GET | `/api/v1/contacts/tags` | [`g8.api.contacts.listContactTags`](contacts.md#op-listcontacttags) | read |
|
|
714
|
+
| POST | `/api/v1/contacts/tags` | [`g8.api.contacts.createContactTag`](contacts.md#op-createcontacttag) | write |
|
|
715
|
+
| POST | `/api/v1/contacts/tags/assign` | [`g8.api.contacts.assignContactTags`](contacts.md#op-assigncontacttags) | write |
|
|
716
|
+
| POST | `/api/v1/contacts/tags/merge` | [`g8.api.contacts.mergeContactTags`](contacts.md#op-mergecontacttags) | write |
|
|
717
|
+
| POST | `/api/v1/contacts/tags/unassign` | [`g8.api.contacts.unassignContactTags`](contacts.md#op-unassigncontacttags) | write |
|
|
718
|
+
| DELETE | `/api/v1/contacts/tags/{tag_id}` | [`g8.api.contacts.deleteContactTag`](contacts.md#op-deletecontacttag) | destructive |
|
|
719
|
+
| PATCH | `/api/v1/contacts/tags/{tag_id}` | [`g8.api.contacts.updateContactTag`](contacts.md#op-updatecontacttag) | write |
|
|
720
|
+
| POST | `/api/v1/contacts/unlock-info` | [`g8.api.contacts.unlockContactInfo`](contacts.md#op-unlockcontactinfo) | billable |
|
|
721
|
+
| POST | `/api/v1/contacts/verify-email` | [`g8.api.contacts.verifyContactEmails`](contacts.md#op-verifycontactemails) | billable |
|
|
722
|
+
| POST | `/api/v1/contacts/verify-email/async` | [`g8.api.contacts.verifyContactEmailsAsync`](contacts.md#op-verifycontactemailsasync) | billable |
|
|
723
|
+
| POST | `/api/v1/contacts/withdraw-from-sequences` | [`g8.api.contacts.withdrawContactsFromSequences`](contacts.md#op-withdrawcontactsfromsequences) | write |
|
|
724
|
+
| GET | `/api/v1/contacts/workflow-executions` | [`g8.api.contacts.listRecordWorkflowExecutions`](contacts.md#op-listrecordworkflowexecutions) | read |
|
|
725
|
+
| POST | `/api/v1/contacts/workflow-executions/run` | [`g8.api.contacts.runRecordWorkflow`](contacts.md#op-runrecordworkflow) | billable |
|
|
726
|
+
| POST | `/api/v1/contacts/workflow-executions/{execution_id}/approve` | [`g8.api.contacts.decideRecordWorkflowExecution`](contacts.md#op-deciderecordworkflowexecution) | write |
|
|
727
|
+
| POST | `/api/v1/contacts/workflow-executions/{execution_id}/cancel` | [`g8.api.contacts.cancelRecordWorkflowExecution`](contacts.md#op-cancelrecordworkflowexecution) | destructive |
|
|
728
|
+
| POST | `/api/v1/contacts/workflow-executions/{execution_id}/pause` | [`g8.api.contacts.pauseRecordWorkflowExecution`](contacts.md#op-pauserecordworkflowexecution) | write |
|
|
729
|
+
| POST | `/api/v1/contacts/workflow-executions/{execution_id}/resume` | [`g8.api.contacts.resumeRecordWorkflowExecution`](contacts.md#op-resumerecordworkflowexecution) | write |
|
|
730
|
+
| DELETE | `/api/v1/contacts/{contact_id}` | [`g8.api.contacts.deleteContact`](contacts.md#op-deletecontact) or `g8.contacts.delete()` | destructive |
|
|
731
|
+
| GET | `/api/v1/contacts/{contact_id}` | [`g8.api.contacts.getContact`](contacts.md#op-getcontact) or `g8.contacts.get()` | read |
|
|
732
|
+
| PATCH | `/api/v1/contacts/{contact_id}` | [`g8.api.contacts.updateContact`](contacts.md#op-updatecontact) or `g8.contacts.update()` | write |
|
|
733
|
+
| GET | `/api/v1/contacts/{contact_id}/analysis` | [`g8.api.contacts.getContactAnalysis`](contacts.md#op-getcontactanalysis) | read |
|
|
734
|
+
| GET | `/api/v1/contacts/{contact_id}/dashboard` | [`g8.api.contacts.getContactDashboard`](contacts.md#op-getcontactdashboard) | read |
|
|
735
|
+
| GET | `/api/v1/contacts/{contact_id}/deals` | [`g8.api.deals.getContactDeals`](deals.md#op-getcontactdeals) or `g8.deals.forContact()` | read |
|
|
736
|
+
| PUT | `/api/v1/contacts/{contact_id}/deals/assert` | [`g8.api.assertUpsert.assertDealContact`](assertUpsert.md#op-assertdealcontact) | write |
|
|
737
|
+
| GET | `/api/v1/contacts/{contact_id}/detail` | [`g8.api.contacts.getContactDetail`](contacts.md#op-getcontactdetail) | read |
|
|
738
|
+
| GET | `/api/v1/contacts/{contact_id}/documents` | [`g8.api.contacts.listContactDocuments`](contacts.md#op-listcontactdocuments) | read |
|
|
739
|
+
| POST | `/api/v1/contacts/{contact_id}/documents/from-skill` | [`g8.api.contacts.saveSkillResultToContact`](contacts.md#op-saveskillresulttocontact) | write |
|
|
740
|
+
| POST | `/api/v1/contacts/{contact_id}/documents/generate-all` | [`g8.api.contacts.generateAllContactDocuments`](contacts.md#op-generateallcontactdocuments) | billable |
|
|
741
|
+
| GET | `/api/v1/contacts/{contact_id}/documents/generation-status` | [`g8.api.contacts.getContactGenerationStatus`](contacts.md#op-getcontactgenerationstatus) | read |
|
|
742
|
+
| GET | `/api/v1/contacts/{contact_id}/documents/types/{doc_type}` | [`g8.api.contacts.getContactDocument`](contacts.md#op-getcontactdocument) | read |
|
|
743
|
+
| POST | `/api/v1/contacts/{contact_id}/documents/types/{doc_type}/generate` | [`g8.api.contacts.generateContactDocument`](contacts.md#op-generatecontactdocument) | billable |
|
|
744
|
+
| POST | `/api/v1/contacts/{contact_id}/documents/types/{doc_type}/regenerate` | [`g8.api.contacts.regenerateContactDocument`](contacts.md#op-regeneratecontactdocument) | billable |
|
|
745
|
+
| DELETE | `/api/v1/contacts/{contact_id}/documents/{document_id}` | [`g8.api.contacts.deleteContactDocument`](contacts.md#op-deletecontactdocument) | destructive |
|
|
746
|
+
| PUT | `/api/v1/contacts/{contact_id}/documents/{document_id}` | [`g8.api.contacts.updateContactDocument`](contacts.md#op-updatecontactdocument) | write |
|
|
747
|
+
| GET | `/api/v1/contacts/{contact_id}/engagement-summary` | [`g8.api.contacts.getContactEngagementSummary`](contacts.md#op-getcontactengagementsummary) | read |
|
|
748
|
+
| GET | `/api/v1/contacts/{contact_id}/lifecycle-snapshot` | [`g8.api.revenueRecords.getContactLifecycleSnapshot`](revenueRecords.md#op-getcontactlifecyclesnapshot) | read |
|
|
749
|
+
| POST | `/api/v1/contacts/{contact_id}/lifecycle-stage` | [`g8.api.revenueLifecycle.moveContactLifecycleStage`](revenueLifecycle.md#op-movecontactlifecyclestage) | write |
|
|
750
|
+
| GET | `/api/v1/contacts/{contact_id}/lists` | [`g8.api.contacts.getContactLists`](contacts.md#op-getcontactlists) | read |
|
|
751
|
+
| GET | `/api/v1/contacts/{contact_id}/meetings` | [`g8.api.contacts.getContactMeetings`](contacts.md#op-getcontactmeetings) | read |
|
|
752
|
+
| POST | `/api/v1/contacts/{contact_id}/merge` | [`g8.api.contacts.mergeContact`](contacts.md#op-mergecontact) | destructive |
|
|
753
|
+
| GET | `/api/v1/contacts/{contact_id}/merge/preview` | [`g8.api.contacts.previewContactMerge`](contacts.md#op-previewcontactmerge) | read |
|
|
754
|
+
| GET | `/api/v1/contacts/{contact_id}/next-best-step` | [`g8.api.contacts.getContactNextBestStep`](contacts.md#op-getcontactnextbeststep) | billable |
|
|
755
|
+
| GET | `/api/v1/contacts/{contact_id}/notes` | [`g8.api.notes.listNotes`](notes.md#op-listnotes) or `g8.notes.list()` | read |
|
|
756
|
+
| POST | `/api/v1/contacts/{contact_id}/notes` | [`g8.api.notes.createNote`](notes.md#op-createnote) or `g8.notes.create()` | write |
|
|
757
|
+
| GET | `/api/v1/contacts/{contact_id}/quotes` | [`g8.api.quotes.getContactQuotes`](quotes.md#op-getcontactquotes) or `g8.quotes.forContact()` | read |
|
|
758
|
+
| GET | `/api/v1/contacts/{contact_id}/sequences` | [`g8.api.contacts.getContactSequences`](contacts.md#op-getcontactsequences) | read |
|
|
759
|
+
| GET | `/api/v1/contacts/{contact_id}/signals` | [`g8.api.contacts.getContactSignals`](contacts.md#op-getcontactsignals) | read |
|
|
760
|
+
| GET | `/api/v1/contacts/{contact_id}/sites-visited` | [`g8.api.contacts.getContactSitesVisited`](contacts.md#op-getcontactsitesvisited) | read |
|
|
761
|
+
| POST | `/api/v1/contacts/{contact_id}/suppress` | [`g8.api.suppressions.suppressContact`](suppressions.md#op-suppresscontact) | write |
|
|
762
|
+
| GET | `/api/v1/contacts/{contact_id}/suppression` | [`g8.api.suppressions.checkContactSuppression`](suppressions.md#op-checkcontactsuppression) | read |
|
|
763
|
+
| GET | `/api/v1/contacts/{contact_id}/tags` | [`g8.api.contacts.getContactTagIds`](contacts.md#op-getcontacttagids) | read |
|
|
764
|
+
| GET | `/api/v1/contacts/{contact_id}/tasks` | [`g8.api.tasks.listContactTasks`](tasks.md#op-listcontacttasks) or `g8.tasks.listForContact()` | read |
|
|
765
|
+
| POST | `/api/v1/contacts/{contact_id}/tasks` | [`g8.api.tasks.createTask`](tasks.md#op-createtask) or `g8.tasks.create()` | write |
|
|
766
|
+
| POST | `/api/v1/contacts/{contact_id}/unsuppress` | [`g8.api.suppressions.unsuppressContact`](suppressions.md#op-unsuppresscontact) | write |
|
|
767
|
+
| POST | `/api/v1/content-workspace/import/crawl` | [`g8.api.content.startContentCrawlImport`](content.md#op-startcontentcrawlimport) | billable |
|
|
768
|
+
| GET | `/api/v1/content-workspace/import/jobs` | [`g8.api.content.listContentImportJobs`](content.md#op-listcontentimportjobs) | read |
|
|
769
|
+
| POST | `/api/v1/content-workspace/import/sitemap` | [`g8.api.content.startContentSitemapImport`](content.md#op-startcontentsitemapimport) | write |
|
|
770
|
+
| GET | `/api/v1/content-workspace/import/status/{job_id}` | [`g8.api.content.getContentImportStatus`](content.md#op-getcontentimportstatus) | read |
|
|
771
|
+
| GET | `/api/v1/content-workspace/pages` | [`g8.api.content.listContentWorkspacePages`](content.md#op-listcontentworkspacepages) | read |
|
|
772
|
+
| DELETE | `/api/v1/content-workspace/pages/{page_id}` | [`g8.api.content.deleteContentWorkspacePage`](content.md#op-deletecontentworkspacepage) | destructive |
|
|
773
|
+
| GET | `/api/v1/content-workspace/pages/{page_id}` | [`g8.api.content.getContentWorkspacePage`](content.md#op-getcontentworkspacepage) | read |
|
|
774
|
+
| PATCH | `/api/v1/content-workspace/pages/{page_id}` | [`g8.api.content.updateContentWorkspacePage`](content.md#op-updatecontentworkspacepage) | write |
|
|
775
|
+
| GET | `/api/v1/content-workspace/seo-summary` | [`g8.api.content.getContentSeoSummary`](content.md#op-getcontentseosummary) | read |
|
|
776
|
+
| GET | `/api/v1/content/calendar` | [`g8.api.content.getContentCalendar`](content.md#op-getcontentcalendar) | read |
|
|
777
|
+
| GET | `/api/v1/content/calendar/approvals` | [`g8.api.content.listContentApprovalShares`](content.md#op-listcontentapprovalshares) | read |
|
|
778
|
+
| POST | `/api/v1/content/calendar/approvals` | [`g8.api.content.createContentApprovalShare`](content.md#op-createcontentapprovalshare) | write |
|
|
779
|
+
| GET | `/api/v1/content/calendar/ideas` | [`g8.api.content.listContentIdeas`](content.md#op-listcontentideas) | read |
|
|
780
|
+
| GET | `/api/v1/content/calendar/ideas/corpus-stats` | [`g8.api.content.getIdeaCorpusStats`](content.md#op-getideacorpusstats) | read |
|
|
781
|
+
| PATCH | `/api/v1/content/calendar/ideas/{idea_id}` | [`g8.api.content.patchContentIdea`](content.md#op-patchcontentidea) | write |
|
|
782
|
+
| POST | `/api/v1/content/calendar/ideas/{idea_id}/create-content` | [`g8.api.content.createContentFromIdea`](content.md#op-createcontentfromidea) | billable |
|
|
783
|
+
| GET | `/api/v1/content/calendar/ideas/{idea_id}/evidence` | [`g8.api.content.getContentIdeaEvidence`](content.md#op-getcontentideaevidence) | read |
|
|
784
|
+
| POST | `/api/v1/content/calendar/mine-signals` | [`g8.api.content.mineContentSignals`](content.md#op-minecontentsignals) | billable |
|
|
785
|
+
| GET | `/api/v1/content/calendar/mine-signals/status` | [`g8.api.content.getContentSignalMiningStatus`](content.md#op-getcontentsignalminingstatus) | read |
|
|
786
|
+
| POST | `/api/v1/content/calendar/repurpose/ad` | [`g8.api.content.repurposeContentToAd`](content.md#op-repurposecontenttoad) | billable |
|
|
787
|
+
| POST | `/api/v1/content/calendar/repurpose/linkedin-post` | [`g8.api.content.repurposeContentToLinkedinPost`](content.md#op-repurposecontenttolinkedinpost) | billable |
|
|
788
|
+
| POST | `/api/v1/content/calendar/{content_type}/{content_id}/retry-publish` | [`g8.api.content.retryContentPublish`](content.md#op-retrycontentpublish) | external |
|
|
789
|
+
| PATCH | `/api/v1/content/calendar/{content_type}/{content_id}/schedule` | [`g8.api.content.scheduleContentPiece`](content.md#op-schedulecontentpiece) | external |
|
|
790
|
+
| GET | `/api/v1/content/grids` | [`g8.api.content.listContentGrids`](content.md#op-listcontentgrids) | read |
|
|
791
|
+
| POST | `/api/v1/content/grids` | [`g8.api.content.createContentGrid`](content.md#op-createcontentgrid) | write |
|
|
792
|
+
| DELETE | `/api/v1/content/grids/{grid_id}` | [`g8.api.content.deleteContentGrid`](content.md#op-deletecontentgrid) | destructive |
|
|
793
|
+
| GET | `/api/v1/content/grids/{grid_id}` | [`g8.api.content.getContentGrid`](content.md#op-getcontentgrid) | read |
|
|
794
|
+
| POST | `/api/v1/content/grids/{grid_id}/columns` | [`g8.api.contentGridSkills.addContentGridColumn`](contentGridSkills.md#op-addcontentgridcolumn) | write |
|
|
795
|
+
| DELETE | `/api/v1/content/grids/{grid_id}/columns/{column_id}` | [`g8.api.contentGridSkills.removeContentGridColumn`](contentGridSkills.md#op-removecontentgridcolumn) | destructive |
|
|
796
|
+
| PUT | `/api/v1/content/grids/{grid_id}/columns/{column_id}` | [`g8.api.contentGridSkills.updateContentGridColumn`](contentGridSkills.md#op-updatecontentgridcolumn) | write |
|
|
797
|
+
| POST | `/api/v1/content/grids/{grid_id}/columns/{column_id}/run` | [`g8.api.contentGridSkills.runContentGridColumn`](contentGridSkills.md#op-runcontentgridcolumn) | billable |
|
|
798
|
+
| POST | `/api/v1/content/grids/{grid_id}/rows` | [`g8.api.content.addContentGridRow`](content.md#op-addcontentgridrow) | write |
|
|
799
|
+
| DELETE | `/api/v1/content/grids/{grid_id}/rows/{row_id}` | [`g8.api.content.deleteContentGridRow`](content.md#op-deletecontentgridrow) | destructive |
|
|
800
|
+
| POST | `/api/v1/content/grids/{grid_id}/rows/{row_id}/run/{column_id}` | [`g8.api.contentGridSkills.runContentGridCell`](contentGridSkills.md#op-runcontentgridcell) | billable |
|
|
801
|
+
| GET | `/api/v1/content/pages` | [`g8.api.content.listContentPages`](content.md#op-listcontentpages) | read |
|
|
802
|
+
| POST | `/api/v1/content/pages` | [`g8.api.content.createContentPage`](content.md#op-createcontentpage) | write |
|
|
803
|
+
| POST | `/api/v1/content/pages/backfill` | [`g8.api.content.backfillContentPages`](content.md#op-backfillcontentpages) | write |
|
|
804
|
+
| GET | `/api/v1/content/pages/backfill/status/{task_id}` | [`g8.api.content.getContentBackfillStatus`](content.md#op-getcontentbackfillstatus) | read |
|
|
805
|
+
| POST | `/api/v1/content/pages/enrich-seo-bulk` | [`g8.api.content.enrichContentPagesBulk`](content.md#op-enrichcontentpagesbulk) | billable |
|
|
806
|
+
| POST | `/api/v1/content/pages/import-sitemap` | [`g8.api.content.importContentPagesFromSitemap`](content.md#op-importcontentpagesfromsitemap) | write |
|
|
807
|
+
| DELETE | `/api/v1/content/pages/{page_id}` | [`g8.api.content.deleteContentPage`](content.md#op-deletecontentpage) | destructive |
|
|
808
|
+
| GET | `/api/v1/content/pages/{page_id}` | [`g8.api.content.getContentPage`](content.md#op-getcontentpage) | read |
|
|
809
|
+
| PATCH | `/api/v1/content/pages/{page_id}` | [`g8.api.content.updateContentPage`](content.md#op-updatecontentpage) | write |
|
|
810
|
+
| POST | `/api/v1/content/pages/{page_id}/enrich-seo` | [`g8.api.content.enrichContentPage`](content.md#op-enrichcontentpage) | billable |
|
|
811
|
+
| GET | `/api/v1/content/skill-runs/{execution_id}` | [`g8.api.contentGridSkills.getContentSkillRun`](contentGridSkills.md#op-getcontentskillrun) | read |
|
|
812
|
+
| GET | `/api/v1/content/types` | [`g8.api.content.listContentTypes`](content.md#op-listcontenttypes) | read |
|
|
813
|
+
| GET | `/api/v1/content/website-templates` | [`g8.api.content.listWebsiteTemplates`](content.md#op-listwebsitetemplates) | read |
|
|
814
|
+
| POST | `/api/v1/copilot/chat` | [`g8.api.copilot.chatWithCopilot`](copilot.md#op-chatwithcopilot) | billable |
|
|
815
|
+
| POST | `/api/v1/copilot/context/load` | [`g8.api.agents.loadCopilotIntentContext`](agents.md#op-loadcopilotintentcontext) | write |
|
|
816
|
+
| POST | `/api/v1/copilot/landing-page-action` | [`g8.api.copilot.runCopilotLandingPageAction`](copilot.md#op-runcopilotlandingpageaction) | billable |
|
|
817
|
+
| GET | `/api/v1/copilot/memory` | [`g8.api.copilot.listCopilotMemories`](copilot.md#op-listcopilotmemories) | read |
|
|
818
|
+
| POST | `/api/v1/copilot/memory` | [`g8.api.copilot.createCopilotMemory`](copilot.md#op-createcopilotmemory) | write |
|
|
819
|
+
| GET | `/api/v1/copilot/memory/context` | [`g8.api.copilot.getCopilotMemoryContext`](copilot.md#op-getcopilotmemorycontext) | read |
|
|
820
|
+
| GET | `/api/v1/copilot/memory/documents` | [`g8.api.copilot.getCopilotMemoryDocuments`](copilot.md#op-getcopilotmemorydocuments) | read |
|
|
821
|
+
| PUT | `/api/v1/copilot/memory/documents` | [`g8.api.copilot.upsertCopilotMemoryDocument`](copilot.md#op-upsertcopilotmemorydocument) | write |
|
|
822
|
+
| POST | `/api/v1/copilot/memory/documents/append` | [`g8.api.copilot.appendCopilotMemoryDocument`](copilot.md#op-appendcopilotmemorydocument) | write |
|
|
823
|
+
| POST | `/api/v1/copilot/memory/promote` | [`g8.api.copilot.promoteCopilotMemory`](copilot.md#op-promotecopilotmemory) | billable |
|
|
824
|
+
| POST | `/api/v1/copilot/memory/soul-capture` | [`g8.api.copilot.captureCopilotSoul`](copilot.md#op-capturecopilotsoul) | write |
|
|
825
|
+
| DELETE | `/api/v1/copilot/memory/{memory_id}` | [`g8.api.copilot.deleteCopilotMemory`](copilot.md#op-deletecopilotmemory) | destructive |
|
|
826
|
+
| POST | `/api/v1/copilot/mention-search` | [`g8.api.copilot.searchCopilotMentions`](copilot.md#op-searchcopilotmentions) | read |
|
|
827
|
+
| GET | `/api/v1/copilot/personal-wiki` | [`g8.api.copilot.getCopilotPersonalWiki`](copilot.md#op-getcopilotpersonalwiki) | read |
|
|
828
|
+
| PUT | `/api/v1/copilot/personal-wiki` | [`g8.api.copilot.updateCopilotPersonalWiki`](copilot.md#op-updatecopilotpersonalwiki) | write |
|
|
829
|
+
| POST | `/api/v1/copilot/personal-wiki/confirm` | [`g8.api.copilot.confirmCopilotPersonalWikiFact`](copilot.md#op-confirmcopilotpersonalwikifact) | write |
|
|
830
|
+
| GET | `/api/v1/copilot/personal-wiki/contact-identities` | [`g8.api.copilot.searchCopilotContactIdentities`](copilot.md#op-searchcopilotcontactidentities) | read |
|
|
831
|
+
| GET | `/api/v1/copilot/personal-wiki/contact-sharing` | [`g8.api.copilot.getCopilotContactSharing`](copilot.md#op-getcopilotcontactsharing) | read |
|
|
832
|
+
| GET | `/api/v1/copilot/personal-wiki/contact-sharing/contributions` | [`g8.api.copilot.listCopilotContactContributions`](copilot.md#op-listcopilotcontactcontributions) | read |
|
|
833
|
+
| PUT | `/api/v1/copilot/personal-wiki/contact-sharing/contributions/{contribution_id}` | [`g8.api.copilot.updateCopilotContactContribution`](copilot.md#op-updatecopilotcontactcontribution) | write |
|
|
834
|
+
| GET | `/api/v1/copilot/personal-wiki/contact-sharing/contributions/{contribution_id}/matches` | [`g8.api.copilot.listCopilotContactMatches`](copilot.md#op-listcopilotcontactmatches) | read |
|
|
835
|
+
| POST | `/api/v1/copilot/personal-wiki/contact-sharing/contributions/{contribution_id}/matches` | [`g8.api.copilot.chooseCopilotContactMatch`](copilot.md#op-choosecopilotcontactmatch) | write |
|
|
836
|
+
| POST | `/api/v1/copilot/personal-wiki/contact-sharing/contributions/{contribution_id}/resolve` | [`g8.api.copilot.resolveCopilotContactContribution`](copilot.md#op-resolvecopilotcontactcontribution) | write |
|
|
837
|
+
| PUT | `/api/v1/copilot/personal-wiki/contact-sharing/people/choice` | [`g8.api.copilot.updateCopilotContactPeopleChoice`](copilot.md#op-updatecopilotcontactpeoplechoice) | write |
|
|
838
|
+
| PUT | `/api/v1/copilot/personal-wiki/contact-sharing/{mailbox_id}` | [`g8.api.copilot.updateCopilotContactSharing`](copilot.md#op-updatecopilotcontactsharing) | write |
|
|
839
|
+
| POST | `/api/v1/copilot/personal-wiki/correct` | [`g8.api.copilot.correctCopilotPersonalWikiFact`](copilot.md#op-correctcopilotpersonalwikifact) | write |
|
|
840
|
+
| GET | `/api/v1/copilot/personal-wiki/documents/{section}` | [`g8.api.copilot.getCopilotPersonalWikiDocument`](copilot.md#op-getcopilotpersonalwikidocument) | read |
|
|
841
|
+
| GET | `/api/v1/copilot/personal-wiki/drive` | [`g8.api.copilot.browseCopilotPersonalWikiDrive`](copilot.md#op-browsecopilotpersonalwikidrive) | read |
|
|
842
|
+
| PUT | `/api/v1/copilot/personal-wiki/drive-selection` | [`g8.api.copilot.saveCopilotPersonalWikiDriveSelection`](copilot.md#op-savecopilotpersonalwikidriveselection) | write |
|
|
843
|
+
| POST | `/api/v1/copilot/personal-wiki/drive-selection/preview` | [`g8.api.copilot.previewCopilotPersonalWikiDriveSelection`](copilot.md#op-previewcopilotpersonalwikidriveselection) | read |
|
|
844
|
+
| POST | `/api/v1/copilot/personal-wiki/forget` | [`g8.api.copilot.forgetCopilotPersonalWikiFact`](copilot.md#op-forgetcopilotpersonalwikifact) | write |
|
|
845
|
+
| PUT | `/api/v1/copilot/personal-wiki/items/{item_id}` | [`g8.api.copilot.editCopilotPersonalWikiItem`](copilot.md#op-editcopilotpersonalwikiitem) | write |
|
|
846
|
+
| GET | `/api/v1/copilot/personal-wiki/linkedin-connections` | [`g8.api.copilot.getCopilotLinkedinConnections`](copilot.md#op-getcopilotlinkedinconnections) | read |
|
|
847
|
+
| PUT | `/api/v1/copilot/personal-wiki/linkedin-connections` | [`g8.api.copilot.updateCopilotLinkedinConnections`](copilot.md#op-updatecopilotlinkedinconnections) | write |
|
|
848
|
+
| GET | `/api/v1/copilot/personal-wiki/relationships` | [`g8.api.copilot.listCopilotPersonalWikiRelationships`](copilot.md#op-listcopilotpersonalwikirelationships) | read |
|
|
849
|
+
| POST | `/api/v1/copilot/personal-wiki/relationships/identity` | [`g8.api.copilot.correctCopilotContactIdentity`](copilot.md#op-correctcopilotcontactidentity) | write |
|
|
850
|
+
| GET | `/api/v1/copilot/personal-wiki/relationships/{contact_id}` | [`g8.api.copilot.getCopilotPersonalWikiRelationship`](copilot.md#op-getcopilotpersonalwikirelationship) | read |
|
|
851
|
+
| GET | `/api/v1/copilot/personal-wiki/sources` | [`g8.api.copilot.getCopilotPersonalWikiSources`](copilot.md#op-getcopilotpersonalwikisources) | read |
|
|
852
|
+
| PUT | `/api/v1/copilot/personal-wiki/sources` | [`g8.api.copilot.updateCopilotPersonalWikiSources`](copilot.md#op-updatecopilotpersonalwikisources) | write |
|
|
853
|
+
| GET | `/api/v1/copilot/tools` | [`g8.api.copilot.listCopilotTools`](copilot.md#op-listcopilottools) | read |
|
|
854
|
+
| GET | `/api/v1/crm-syncs` | [`g8.api.crmSyncs.listCrmSyncs`](crmSyncs.md#op-listcrmsyncs) | read |
|
|
855
|
+
| POST | `/api/v1/crm-syncs/{provider}/companies/push` | [`g8.api.crmSyncs.pushCompaniesToCrm`](crmSyncs.md#op-pushcompaniestocrm) | external |
|
|
856
|
+
| POST | `/api/v1/crm-syncs/{provider}/contacts/push` | [`g8.api.crmSyncs.pushContactsToCrm`](crmSyncs.md#op-pushcontactstocrm) | external |
|
|
857
|
+
| GET | `/api/v1/crm-syncs/{provider}/fields` | [`g8.api.crmSyncs.getCrmFields`](crmSyncs.md#op-getcrmfields) | read |
|
|
858
|
+
| POST | `/api/v1/crm-syncs/{provider}/lists/push` | [`g8.api.crmSyncs.pushListMemberships`](crmSyncs.md#op-pushlistmemberships) | external |
|
|
859
|
+
| GET | `/api/v1/crm-syncs/{provider}/status` | [`g8.api.crmSyncs.getCrmStatus`](crmSyncs.md#op-getcrmstatus) | read |
|
|
860
|
+
| GET | `/api/v1/customer-success/companies/{company_id}/brief` | [`g8.api.customerSuccess.getBrief`](customerSuccess.md#op-getbrief) | read |
|
|
861
|
+
| POST | `/api/v1/customer-success/companies/{company_id}/brief/synthesize` | [`g8.api.customerSuccess.synthesizeBrief`](customerSuccess.md#op-synthesizebrief) | billable |
|
|
862
|
+
| GET | `/api/v1/customer-success/companies/{company_id}/context` | [`g8.api.customerSuccess.getCompanyContext`](customerSuccess.md#op-getcompanycontext) | read |
|
|
863
|
+
| DELETE | `/api/v1/customer-success/companies/{company_id}/drive-folder` | [`g8.api.customerSuccess.disconnectDriveFolder`](customerSuccess.md#op-disconnectdrivefolder) | destructive |
|
|
864
|
+
| GET | `/api/v1/customer-success/companies/{company_id}/drive-folder` | [`g8.api.customerSuccess.getDriveFolder`](customerSuccess.md#op-getdrivefolder) | read |
|
|
865
|
+
| POST | `/api/v1/customer-success/companies/{company_id}/drive-folder` | [`g8.api.customerSuccess.connectDriveFolder`](customerSuccess.md#op-connectdrivefolder) | write |
|
|
866
|
+
| GET | `/api/v1/customer-success/companies/{company_id}/drive-folder-files` | [`g8.api.customerSuccess.getDriveFolderFiles`](customerSuccess.md#op-getdrivefolderfiles) | read |
|
|
867
|
+
| GET | `/api/v1/customer-success/companies/{company_id}/inbox` | [`g8.api.customerSuccess.getCompanyInbox`](customerSuccess.md#op-getcompanyinbox) | read |
|
|
868
|
+
| GET | `/api/v1/customer-success/companies/{company_id}/meetings` | [`g8.api.customerSuccess.listCompanyMeetings`](customerSuccess.md#op-listcompanymeetings) | read |
|
|
869
|
+
| POST | `/api/v1/customer-success/companies/{company_id}/sync` | [`g8.api.customerSuccess.triggerCompanySync`](customerSuccess.md#op-triggercompanysync) | external |
|
|
870
|
+
| GET | `/api/v1/customer-success/companies/{company_id}/transcripts` | [`g8.api.customerSuccess.listCompanyTranscripts`](customerSuccess.md#op-listcompanytranscripts) | read |
|
|
871
|
+
| GET | `/api/v1/customer-success/companies/{company_id}/transcripts/{transcript_id}` | [`g8.api.customerSuccess.getTranscript`](customerSuccess.md#op-gettranscript) | read |
|
|
872
|
+
| GET | `/api/v1/customer-success/companies/{company_id}/unlinked-transcripts` | [`g8.api.customerSuccess.listUnlinkedTranscripts`](customerSuccess.md#op-listunlinkedtranscripts) | read |
|
|
873
|
+
| GET | `/api/v1/customer-success/contacts/{contact_id}/inbox` | [`g8.api.customerSuccess.getContactInbox`](customerSuccess.md#op-getcontactinbox) | read |
|
|
874
|
+
| PATCH | `/api/v1/customer-success/meetings/{meeting_id}/link-transcript` | [`g8.api.customerSuccess.linkTranscriptToMeeting`](customerSuccess.md#op-linktranscripttomeeting) | write |
|
|
875
|
+
| PATCH | `/api/v1/customer-success/meetings/{meeting_id}/unlink-transcript` | [`g8.api.customerSuccess.unlinkTranscriptFromMeeting`](customerSuccess.md#op-unlinktranscriptfrommeeting) | write |
|
|
876
|
+
| PATCH | `/api/v1/customer-success/transcripts/{transcript_id}/archive` | [`g8.api.customerSuccess.archiveTranscript`](customerSuccess.md#op-archivetranscript) | destructive |
|
|
877
|
+
| PATCH | `/api/v1/customer-success/transcripts/{transcript_id}/link` | [`g8.api.customerSuccess.linkTranscriptToAccount`](customerSuccess.md#op-linktranscripttoaccount) | write |
|
|
878
|
+
| PATCH | `/api/v1/customer-success/transcripts/{transcript_id}/unarchive` | [`g8.api.customerSuccess.unarchiveTranscript`](customerSuccess.md#op-unarchivetranscript) | write |
|
|
879
|
+
| GET | `/api/v1/deals` | [`g8.api.deals.listDeals`](deals.md#op-listdeals) or `g8.deals.list()` | read |
|
|
880
|
+
| POST | `/api/v1/deals` | [`g8.api.deals.createDeal`](deals.md#op-createdeal) or `g8.deals.create()` | write |
|
|
881
|
+
| GET | `/api/v1/deals/analytics` | [`g8.api.deals.getDealAnalytics`](deals.md#op-getdealanalytics) | read |
|
|
882
|
+
| PUT | `/api/v1/deals/assert` | [`g8.api.assertUpsert.assertDeal`](assertUpsert.md#op-assertdeal) | write |
|
|
883
|
+
| POST | `/api/v1/deals/bulk` | [`g8.api.deals.bulkUpdateDeals`](deals.md#op-bulkupdatedeals) | write |
|
|
884
|
+
| GET | `/api/v1/deals/close-reasons` | [`g8.api.deals.listDealCloseReasons`](deals.md#op-listdealclosereasons) | read |
|
|
885
|
+
| POST | `/api/v1/deals/close-reasons` | [`g8.api.deals.createDealCloseReason`](deals.md#op-createdealclosereason) | write |
|
|
886
|
+
| DELETE | `/api/v1/deals/close-reasons/{reason_id}` | [`g8.api.deals.archiveDealCloseReason`](deals.md#op-archivedealclosereason) | destructive |
|
|
887
|
+
| GET | `/api/v1/deals/columns` | [`g8.api.deals.listDealColumns`](deals.md#op-listdealcolumns) | read |
|
|
888
|
+
| POST | `/api/v1/deals/columns/create` | [`g8.api.deals.createDealColumn`](deals.md#op-createdealcolumn) | write |
|
|
889
|
+
| DELETE | `/api/v1/deals/columns/{column_id}` | [`g8.api.deals.deleteDealColumn`](deals.md#op-deletedealcolumn) | destructive |
|
|
890
|
+
| GET | `/api/v1/deals/custom-fields/di-config` | [`g8.api.deals.listDealCustomFieldDiConfig`](deals.md#op-listdealcustomfielddiconfig) | read |
|
|
891
|
+
| POST | `/api/v1/deals/custom-fields/di-config` | [`g8.api.deals.upsertDealCustomFieldDiConfig`](deals.md#op-upsertdealcustomfielddiconfig) | write |
|
|
892
|
+
| GET | `/api/v1/deals/pipelines` | [`g8.api.deals.listPipelines`](deals.md#op-listpipelines) or `g8.deals.pipelines()` | read |
|
|
893
|
+
| PUT | `/api/v1/deals/pipelines/{pipeline_id}/default` | [`g8.api.revenueRecords.setDefaultPipeline`](revenueRecords.md#op-setdefaultpipeline) | write |
|
|
894
|
+
| GET | `/api/v1/deals/stage-velocity` | [`g8.api.deals.getDealStageVelocity`](deals.md#op-getdealstagevelocity) | read |
|
|
895
|
+
| DELETE | `/api/v1/deals/{deal_id}` | [`g8.api.deals.deleteDeal`](deals.md#op-deletedeal) or `g8.deals.delete()` | destructive |
|
|
896
|
+
| GET | `/api/v1/deals/{deal_id}` | [`g8.api.deals.getDeal`](deals.md#op-getdeal) or `g8.deals.get()` | read |
|
|
897
|
+
| PATCH | `/api/v1/deals/{deal_id}` | [`g8.api.deals.updateDeal`](deals.md#op-updatedeal) or `g8.deals.update()` | write |
|
|
898
|
+
| GET | `/api/v1/deals/{deal_id}/activities` | [`g8.api.revenueRecords.listDealActivities`](revenueRecords.md#op-listdealactivities) | read |
|
|
899
|
+
| POST | `/api/v1/deals/{deal_id}/advance-stage` | [`g8.api.meetings.advanceDealStage`](meetings.md#op-advancedealstage) | write |
|
|
900
|
+
| PUT | `/api/v1/deals/{deal_id}/columns/values` | [`g8.api.deals.setDealColumnValues`](deals.md#op-setdealcolumnvalues) | write |
|
|
901
|
+
| PUT | `/api/v1/deals/{deal_id}/company` | [`g8.api.deals.setDealCompany`](deals.md#op-setdealcompany) | write |
|
|
902
|
+
| GET | `/api/v1/deals/{deal_id}/contacts` | [`g8.api.deals.listDealContacts`](deals.md#op-listdealcontacts) | read |
|
|
903
|
+
| POST | `/api/v1/deals/{deal_id}/contacts` | [`g8.api.deals.addDealContact`](deals.md#op-adddealcontact) | write |
|
|
904
|
+
| PUT | `/api/v1/deals/{deal_id}/contacts/{contact_id}` | [`g8.api.deals.setDealContactRole`](deals.md#op-setdealcontactrole) | write |
|
|
905
|
+
| DELETE | `/api/v1/deals/{deal_id}/contacts/{person_id}` | [`g8.api.deals.removeDealContact`](deals.md#op-removedealcontact) | destructive |
|
|
906
|
+
| PUT | `/api/v1/deals/{deal_id}/contacts/{person_id}/primary` | [`g8.api.deals.setPrimaryDealContact`](deals.md#op-setprimarydealcontact) | write |
|
|
907
|
+
| GET | `/api/v1/deals/{deal_id}/crossfire` | [`g8.api.deals.getDealCrossfire`](deals.md#op-getdealcrossfire) | read |
|
|
908
|
+
| GET | `/api/v1/deals/{deal_id}/detail` | [`g8.api.deals.getDealDetail`](deals.md#op-getdealdetail) | read |
|
|
909
|
+
| GET | `/api/v1/deals/{deal_id}/documents` | [`g8.api.deals.listDealDocuments`](deals.md#op-listdealdocuments) | read |
|
|
910
|
+
| POST | `/api/v1/deals/{deal_id}/documents/generate-all` | [`g8.api.deals.generateAllDealDocuments`](deals.md#op-generatealldealdocuments) | billable |
|
|
911
|
+
| GET | `/api/v1/deals/{deal_id}/documents/generation-status` | [`g8.api.deals.getDealDocumentGenerationStatus`](deals.md#op-getdealdocumentgenerationstatus) | read |
|
|
912
|
+
| GET | `/api/v1/deals/{deal_id}/documents/types/{doc_type}` | [`g8.api.deals.getDealDocument`](deals.md#op-getdealdocument) | read |
|
|
913
|
+
| POST | `/api/v1/deals/{deal_id}/documents/types/{doc_type}/generate` | [`g8.api.deals.generateDealDocument`](deals.md#op-generatedealdocument) | billable |
|
|
914
|
+
| POST | `/api/v1/deals/{deal_id}/documents/types/{doc_type}/regenerate` | [`g8.api.deals.regenerateDealDocument`](deals.md#op-regeneratedealdocument) | billable |
|
|
915
|
+
| DELETE | `/api/v1/deals/{deal_id}/documents/{document_id}` | [`g8.api.deals.deleteDealDocument`](deals.md#op-deletedealdocument) | destructive |
|
|
916
|
+
| PUT | `/api/v1/deals/{deal_id}/documents/{document_id}` | [`g8.api.deals.updateDealDocument`](deals.md#op-updatedealdocument) | write |
|
|
917
|
+
| GET | `/api/v1/deals/{deal_id}/history` | [`g8.api.deals.listDealHistory`](deals.md#op-listdealhistory) | read |
|
|
918
|
+
| GET | `/api/v1/deals/{deal_id}/line-items` | [`g8.api.deals.listDealLineItems`](deals.md#op-listdeallineitems) | read |
|
|
919
|
+
| PUT | `/api/v1/deals/{deal_id}/line-items` | [`g8.api.deals.replaceDealLineItems`](deals.md#op-replacedeallineitems) | write |
|
|
920
|
+
| GET | `/api/v1/deals/{deal_id}/memory` | [`g8.api.meetings.getDealMemory`](meetings.md#op-getdealmemory) | read |
|
|
921
|
+
| POST | `/api/v1/deals/{deal_id}/merge` | [`g8.api.deals.mergeDeal`](deals.md#op-mergedeal) | destructive |
|
|
922
|
+
| GET | `/api/v1/deals/{deal_id}/merge/preview` | [`g8.api.deals.previewDealMerge`](deals.md#op-previewdealmerge) | read |
|
|
923
|
+
| POST | `/api/v1/deals/{deal_id}/next-best-step` | [`g8.api.meetings.suggestDealNextBestStep`](meetings.md#op-suggestdealnextbeststep) | billable |
|
|
924
|
+
| GET | `/api/v1/deals/{deal_id}/notes` | [`g8.api.notes.listDealNotes`](notes.md#op-listdealnotes) or `g8.notes.listForDeal()` | read |
|
|
925
|
+
| POST | `/api/v1/deals/{deal_id}/notes` | [`g8.api.notes.createDealNote`](notes.md#op-createdealnote) or `g8.notes.createForDeal()` | write |
|
|
926
|
+
| DELETE | `/api/v1/deals/{deal_id}/notes/{note_id}` | [`g8.api.deals.deleteDealNote`](deals.md#op-deletedealnote) | destructive |
|
|
927
|
+
| PUT | `/api/v1/deals/{deal_id}/notes/{note_id}` | [`g8.api.deals.updateDealNote`](deals.md#op-updatedealnote) | write |
|
|
928
|
+
| PUT | `/api/v1/deals/{deal_id}/pipeline` | [`g8.api.deals.moveDealToPipeline`](deals.md#op-movedealtopipeline) | write |
|
|
929
|
+
| POST | `/api/v1/deals/{deal_id}/rival-attach` | [`g8.api.deals.setRivalAttach`](deals.md#op-setrivalattach) | write |
|
|
930
|
+
| GET | `/api/v1/deals/{deal_id}/signals` | [`g8.api.deals.getDealSignals`](deals.md#op-getdealsignals) | read |
|
|
931
|
+
| GET | `/api/v1/deals/{deal_id}/stage-readiness` | [`g8.api.meetings.getDealStageReadiness`](meetings.md#op-getdealstagereadiness) | read |
|
|
932
|
+
| GET | `/api/v1/deliverability/autopilot/approvals` | [`g8.api.deliverability.listAutopilotApprovals`](deliverability.md#op-listautopilotapprovals) | read |
|
|
933
|
+
| GET | `/api/v1/deliverability/autopilot/preferences` | [`g8.api.deliverability.getAutopilotPreferences`](deliverability.md#op-getautopilotpreferences) | read |
|
|
934
|
+
| PUT | `/api/v1/deliverability/autopilot/preferences` | [`g8.api.deliverability.setAutopilotPreferences`](deliverability.md#op-setautopilotpreferences) | billable |
|
|
935
|
+
| POST | `/api/v1/deliverability/blocklist/check` | [`g8.api.deliverability.checkDomainBlocklist`](deliverability.md#op-checkdomainblocklist) | read |
|
|
936
|
+
| GET | `/api/v1/deliverability/capacity-plan` | [`g8.api.deliverability.getCapacityPlan`](deliverability.md#op-getcapacityplan) | read |
|
|
937
|
+
| GET | `/api/v1/deliverability/degraded` | [`g8.api.deliverability.listDegradedMailboxes`](deliverability.md#op-listdegradedmailboxes) | read |
|
|
938
|
+
| GET | `/api/v1/deliverability/domain/{domain}/report` | [`g8.api.deliverability.getDomainReport`](deliverability.md#op-getdomainreport) | read |
|
|
939
|
+
| GET | `/api/v1/deliverability/findings` | [`g8.api.deliverability.listDeliverabilityFindings`](deliverability.md#op-listdeliverabilityfindings) | read |
|
|
940
|
+
| GET | `/api/v1/deliverability/fleet-summary` | [`g8.api.deliverability.getFleetSummary`](deliverability.md#op-getfleetsummary) | read |
|
|
941
|
+
| GET | `/api/v1/deliverability/metrics` | [`g8.api.gtmDeliverability.getDeliverabilityMetrics`](gtmDeliverability.md#op-getdeliverabilitymetrics) | read |
|
|
942
|
+
| GET | `/api/v1/deliverability/recovery` | [`g8.api.deliverability.getMailboxRecoveryOverview`](deliverability.md#op-getmailboxrecoveryoverview) | read |
|
|
943
|
+
| POST | `/api/v1/deliverability/recovery/decide` | [`g8.api.deliverability.decideMailboxRetirement`](deliverability.md#op-decidemailboxretirement) | destructive |
|
|
944
|
+
| GET | `/api/v1/deliverability/recovery/mailboxes/{mailbox_id}/history` | [`g8.api.deliverability.getMailboxRecoveryHistory`](deliverability.md#op-getmailboxrecoveryhistory) | read |
|
|
945
|
+
| POST | `/api/v1/deliverability/recovery/removal-requests` | [`g8.api.deliverability.createBlocklistRemovalRequest`](deliverability.md#op-createblocklistremovalrequest) | write |
|
|
946
|
+
| PATCH | `/api/v1/deliverability/recovery/removal-requests/{request_id}` | [`g8.api.deliverability.updateBlocklistRemovalRequest`](deliverability.md#op-updateblocklistremovalrequest) | write |
|
|
947
|
+
| POST | `/api/v1/deliverability/recovery/undo` | [`g8.api.deliverability.undoMailboxRetirement`](deliverability.md#op-undomailboxretirement) | write |
|
|
948
|
+
| GET | `/api/v1/deliverability/safe-to-send` | [`g8.api.deliverability.getSafeToSend`](deliverability.md#op-getsafetosend) | read |
|
|
949
|
+
| GET | `/api/v1/deliverability/sequences-health` | [`g8.api.deliverability.getSequencesHealth`](deliverability.md#op-getsequenceshealth) | read |
|
|
950
|
+
| GET | `/api/v1/desk/accounts/plans` | [`g8.api.desk.listAccountPlans`](desk.md#op-listaccountplans) | read |
|
|
951
|
+
| POST | `/api/v1/desk/accounts/{account_id}/committee` | [`g8.api.desk.editAccountCommittee`](desk.md#op-editaccountcommittee) | write |
|
|
952
|
+
| GET | `/api/v1/desk/accounts/{account_id}/committee/plays` | [`g8.api.desk.listCommitteePlays`](desk.md#op-listcommitteeplays) | read |
|
|
953
|
+
| GET | `/api/v1/desk/accounts/{account_id}/committee/plays/{action_id}/check` | [`g8.api.desk.checkCommitteePlay`](desk.md#op-checkcommitteeplay) | read |
|
|
954
|
+
| POST | `/api/v1/desk/accounts/{account_id}/committee/plays/{action_id}/run` | [`g8.api.desk.runCommitteePlay`](desk.md#op-runcommitteeplay) | external |
|
|
955
|
+
| POST | `/api/v1/desk/accounts/{account_id}/committee/{contact_id}/find-linkedin` | [`g8.api.desk.findCommitteeMemberLinkedin`](desk.md#op-findcommitteememberlinkedin) | billable |
|
|
956
|
+
| POST | `/api/v1/desk/accounts/{account_id}/committee/{contact_id}/linkedin-invite` | [`g8.api.desk.sendCommitteeLinkedinInvite`](desk.md#op-sendcommitteelinkedininvite) | external |
|
|
957
|
+
| GET | `/api/v1/desk/accounts/{account_id}/context` | [`g8.api.desk.getAccountContext`](desk.md#op-getaccountcontext) | read |
|
|
958
|
+
| GET | `/api/v1/desk/accounts/{account_id}/plan` | [`g8.api.desk.getAccountPlan`](desk.md#op-getaccountplan) | read |
|
|
959
|
+
| POST | `/api/v1/desk/accounts/{account_id}/plan` | [`g8.api.desk.createOrReplanAccountPlan`](desk.md#op-createorreplanaccountplan) | write |
|
|
960
|
+
| POST | `/api/v1/desk/accounts/{account_id}/plan/apply` | [`g8.api.desk.applyAccountPlan`](desk.md#op-applyaccountplan) | write |
|
|
961
|
+
| POST | `/api/v1/desk/accounts/{account_id}/plan/draft` | [`g8.api.desk.draftAccountPlan`](desk.md#op-draftaccountplan) | billable |
|
|
962
|
+
| GET | `/api/v1/desk/accounts/{account_id}/plan/history` | [`g8.api.desk.getAccountPlanHistory`](desk.md#op-getaccountplanhistory) | read |
|
|
963
|
+
| POST | `/api/v1/desk/accounts/{account_id}/plan/preview` | [`g8.api.desk.previewAccountPlan`](desk.md#op-previewaccountplan) | read |
|
|
964
|
+
| PUT | `/api/v1/desk/accounts/{account_id}/plan/steps/{step_id}` | [`g8.api.desk.updateAccountPlanStep`](desk.md#op-updateaccountplanstep) | write |
|
|
965
|
+
| POST | `/api/v1/desk/ask` | [`g8.api.desk.askDesk`](desk.md#op-askdesk) | billable |
|
|
966
|
+
| GET | `/api/v1/desk/autonomy` | [`g8.api.desk.getDeskAutonomy`](desk.md#op-getdeskautonomy) | read |
|
|
967
|
+
| PUT | `/api/v1/desk/autonomy` | [`g8.api.desk.updateDeskAutonomy`](desk.md#op-updatedeskautonomy) | external |
|
|
968
|
+
| GET | `/api/v1/desk/batch` | [`g8.api.desk.getDeskBatch`](desk.md#op-getdeskbatch) | read |
|
|
969
|
+
| POST | `/api/v1/desk/batch/pull` | [`g8.api.desk.pullDeskBatch`](desk.md#op-pulldeskbatch) | write |
|
|
970
|
+
| POST | `/api/v1/desk/batch/start` | [`g8.api.desk.startDeskBatch`](desk.md#op-startdeskbatch) | write |
|
|
971
|
+
| GET | `/api/v1/desk/blocks` | [`g8.api.desk.listDeskBlocks`](desk.md#op-listdeskblocks) | read |
|
|
972
|
+
| GET | `/api/v1/desk/blocks/{list_id}/queue` | [`g8.api.desk.getDeskBlockQueue`](desk.md#op-getdeskblockqueue) | read |
|
|
973
|
+
| GET | `/api/v1/desk/committee-heat` | [`g8.api.desk.getDeskCommitteeHeat`](desk.md#op-getdeskcommitteeheat) | read |
|
|
974
|
+
| GET | `/api/v1/desk/committee-targets` | [`g8.api.desk.getDeskCommitteeTargets`](desk.md#op-getdeskcommitteetargets) | read |
|
|
975
|
+
| GET | `/api/v1/desk/compliance-summary` | [`g8.api.desk.getDeskComplianceSummary`](desk.md#op-getdeskcompliancesummary) | read |
|
|
976
|
+
| POST | `/api/v1/desk/contacts/{contact_id}/call-target` | [`g8.api.desk.getDeskContactCallTarget`](desk.md#op-getdeskcontactcalltarget) | read |
|
|
977
|
+
| GET | `/api/v1/desk/coverage` | [`g8.api.desk.getDeskCoverage`](desk.md#op-getdeskcoverage) | read |
|
|
978
|
+
| GET | `/api/v1/desk/decisions` | [`g8.api.desk.listDeskDecisions`](desk.md#op-listdeskdecisions) | read |
|
|
979
|
+
| GET | `/api/v1/desk/decisions/completed` | [`g8.api.desk.listCompletedDeskDecisions`](desk.md#op-listcompleteddeskdecisions) | read |
|
|
980
|
+
| GET | `/api/v1/desk/decisions/{decision_id}/brief` | [`g8.api.desk.getDeskDecisionBrief`](desk.md#op-getdeskdecisionbrief) | read |
|
|
981
|
+
| POST | `/api/v1/desk/decisions/{decision_id}/call-target` | [`g8.api.desk.getDeskCallTarget`](desk.md#op-getdeskcalltarget) | read |
|
|
982
|
+
| GET | `/api/v1/desk/decisions/{decision_id}/card-context` | [`g8.api.desk.getDeskDecisionCardContext`](desk.md#op-getdeskdecisioncardcontext) | read |
|
|
983
|
+
| GET | `/api/v1/desk/decisions/{decision_id}/conversation` | [`g8.api.desk.getDeskDecisionConversation`](desk.md#op-getdeskdecisionconversation) | read |
|
|
984
|
+
| GET | `/api/v1/desk/decisions/{decision_id}/plays` | [`g8.api.desk.listDeskCardPlays`](desk.md#op-listdeskcardplays) | read |
|
|
985
|
+
| POST | `/api/v1/desk/decisions/{decision_id}/plays/{action_id}/run` | [`g8.api.desk.runDeskCardPlay`](desk.md#op-rundeskcardplay) | external |
|
|
986
|
+
| POST | `/api/v1/desk/decisions/{decision_id}/replan` | [`g8.api.desk.replanDeskDecision`](desk.md#op-replandeskdecision) | billable |
|
|
987
|
+
| POST | `/api/v1/desk/decisions/{decision_id}/reply-target` | [`g8.api.desk.getDeskReplyTarget`](desk.md#op-getdeskreplytarget) | read |
|
|
988
|
+
| POST | `/api/v1/desk/decisions/{decision_id}/resolve` | [`g8.api.desk.resolveDeskDecision`](desk.md#op-resolvedeskdecision) | write |
|
|
989
|
+
| POST | `/api/v1/desk/decisions/{decision_id}/send-reply` | [`g8.api.desk.sendDeskReply`](desk.md#op-senddeskreply) | external |
|
|
990
|
+
| POST | `/api/v1/desk/decisions/{decision_id}/send-sms` | [`g8.api.desk.sendDeskSms`](desk.md#op-senddesksms) | external |
|
|
991
|
+
| POST | `/api/v1/desk/decisions/{decision_id}/sms-target` | [`g8.api.desk.getDeskSmsTarget`](desk.md#op-getdesksmstarget) | read |
|
|
992
|
+
| POST | `/api/v1/desk/decisions/{decision_id}/undo` | [`g8.api.desk.undoDeskDecision`](desk.md#op-undodeskdecision) | write |
|
|
993
|
+
| POST | `/api/v1/desk/decisions/{decision_id}/unsnooze` | [`g8.api.desk.unsnoozeDeskDecision`](desk.md#op-unsnoozedeskdecision) | write |
|
|
994
|
+
| POST | `/api/v1/desk/email-improve` | [`g8.api.desk.improveDeskEmail`](desk.md#op-improvedeskemail) | billable |
|
|
995
|
+
| POST | `/api/v1/desk/email-score` | [`g8.api.desk.scoreDeskEmail`](desk.md#op-scoredeskemail) | billable |
|
|
996
|
+
| GET | `/api/v1/desk/home-summary` | [`g8.api.desk.getDeskHomeSummary`](desk.md#op-getdeskhomesummary) | read |
|
|
997
|
+
| GET | `/api/v1/desk/kickoff` | [`g8.api.desk.getDeskKickoff`](desk.md#op-getdeskkickoff) | billable |
|
|
998
|
+
| GET | `/api/v1/desk/kickoff/audio` | [`g8.api.desk.getDeskKickoffAudio`](desk.md#op-getdeskkickoffaudio) | billable |
|
|
999
|
+
| POST | `/api/v1/desk/kickoff/played` | [`g8.api.desk.markDeskKickoffPlayed`](desk.md#op-markdeskkickoffplayed) | write |
|
|
1000
|
+
| GET | `/api/v1/desk/linkedin-sender` | [`g8.api.desk.getDeskLinkedinSender`](desk.md#op-getdesklinkedinsender) | read |
|
|
1001
|
+
| PUT | `/api/v1/desk/linkedin-sender` | [`g8.api.desk.updateDeskLinkedinSender`](desk.md#op-updatedesklinkedinsender) | write |
|
|
1002
|
+
| GET | `/api/v1/desk/list-goals` | [`g8.api.desk.getDeskListGoals`](desk.md#op-getdesklistgoals) | read |
|
|
1003
|
+
| PUT | `/api/v1/desk/list-goals` | [`g8.api.desk.updateDeskListGoal`](desk.md#op-updatedesklistgoal) | write |
|
|
1004
|
+
| POST | `/api/v1/desk/list-goals/{list_id}/revive` | [`g8.api.desk.reviveDeskListGoal`](desk.md#op-revivedesklistgoal) | write |
|
|
1005
|
+
| GET | `/api/v1/desk/list-group-override` | [`g8.api.desk.getDeskListGroupOverride`](desk.md#op-getdesklistgroupoverride) | read |
|
|
1006
|
+
| PUT | `/api/v1/desk/list-group-override` | [`g8.api.desk.updateDeskListGroupOverride`](desk.md#op-updatedesklistgroupoverride) | write |
|
|
1007
|
+
| GET | `/api/v1/desk/list-priority` | [`g8.api.desk.getDeskListPriority`](desk.md#op-getdesklistpriority) | read |
|
|
1008
|
+
| PUT | `/api/v1/desk/list-priority` | [`g8.api.desk.updateDeskListPriority`](desk.md#op-updatedesklistpriority) | write |
|
|
1009
|
+
| GET | `/api/v1/desk/next-best` | [`g8.api.desk.getDeskNextBest`](desk.md#op-getdesknextbest) | read |
|
|
1010
|
+
| GET | `/api/v1/desk/org-settings` | [`g8.api.desk.getDeskOrgSettings`](desk.md#op-getdeskorgsettings) | read |
|
|
1011
|
+
| PUT | `/api/v1/desk/org-settings` | [`g8.api.desk.updateDeskOrgSettings`](desk.md#op-updatedeskorgsettings) | external |
|
|
1012
|
+
| GET | `/api/v1/desk/org-settings/plan-stages/check` | [`g8.api.desk.checkDeskPlanStageSweep`](desk.md#op-checkdeskplanstagesweep) | read |
|
|
1013
|
+
| POST | `/api/v1/desk/org-settings/plan-stages/run` | [`g8.api.desk.runDeskPlanStageSweep`](desk.md#op-rundeskplanstagesweep) | billable |
|
|
1014
|
+
| GET | `/api/v1/desk/plays/approvals` | [`g8.api.desk.listDeskPlayApprovals`](desk.md#op-listdeskplayapprovals) | read |
|
|
1015
|
+
| POST | `/api/v1/desk/plays/approvals/{execution_id}/decide` | [`g8.api.desk.decideDeskPlayApproval`](desk.md#op-decidedeskplayapproval) | external |
|
|
1016
|
+
| GET | `/api/v1/desk/plays/executions/{execution_id}` | [`g8.api.desk.getDeskPlayExecution`](desk.md#op-getdeskplayexecution) | read |
|
|
1017
|
+
| GET | `/api/v1/desk/pulse` | [`g8.api.desk.getDeskPulse`](desk.md#op-getdeskpulse) | read |
|
|
1018
|
+
| GET | `/api/v1/desk/upcoming` | [`g8.api.desk.listDeskUpcoming`](desk.md#op-listdeskupcoming) | read |
|
|
1019
|
+
| POST | `/api/v1/desk/voice-memo` | [`g8.api.desk.postDeskVoiceMemo`](desk.md#op-postdeskvoicememo) | billable |
|
|
1020
|
+
| GET | `/api/v1/desk/wrapped` | [`g8.api.desk.getDeskWrapped`](desk.md#op-getdeskwrapped) | read |
|
|
1021
|
+
| DELETE | `/api/v1/dialer/dispositions/{disposition_id}` | [`g8.api.dialer.deleteCustomDisposition`](dialer.md#op-deletecustomdisposition) | destructive |
|
|
1022
|
+
| GET | `/api/v1/dialer/dispositions/{disposition_id}/usage` | [`g8.api.voice.getDispositionUsage`](voice.md#op-getdispositionusage) | read |
|
|
1023
|
+
| GET | `/api/v1/dialer/parallel-calls/analytics/dialer-report` | [`g8.api.dialer.readDialerReport`](dialer.md#op-readdialerreport) | read |
|
|
1024
|
+
| GET | `/api/v1/dialer/parallel-calls/analytics/dialer-report/export` | [`g8.api.voice.exportDialerReport`](voice.md#op-exportdialerreport) | read |
|
|
1025
|
+
| POST | `/api/v1/dialer/parallel-calls/calls/hangup` | [`g8.api.dialer.hangupParallelCall`](dialer.md#op-hangupparallelcall) | write |
|
|
1026
|
+
| PATCH | `/api/v1/dialer/parallel-calls/calls/{livekit_room_name}/disposition` | [`g8.api.dialer.setCallDisposition`](dialer.md#op-setcalldisposition) | write |
|
|
1027
|
+
| POST | `/api/v1/dialer/parallel-calls/calls/{livekit_room_name}/drop-voicemail` | [`g8.api.dialer.dropParallelVoicemail`](dialer.md#op-dropparallelvoicemail) | external |
|
|
1028
|
+
| POST | `/api/v1/dialer/parallel-calls/calls/{livekit_room_name}/grading/review` | [`g8.api.dialer.markGradingReviewed`](dialer.md#op-markgradingreviewed) | write |
|
|
1029
|
+
| POST | `/api/v1/dialer/parallel-calls/grading/backfill` | [`g8.api.dialer.backfillGrading`](dialer.md#op-backfillgrading) | billable |
|
|
1030
|
+
| GET | `/api/v1/dialer/parallel-calls/grading/campaign-readiness` | [`g8.api.dialer.checkCampaignReadiness`](dialer.md#op-checkcampaignreadiness) | read |
|
|
1031
|
+
| POST | `/api/v1/dialer/parallel-calls/manual-dial` | [`g8.api.dialer.manualDial`](dialer.md#op-manualdial) | external |
|
|
1032
|
+
| PATCH | `/api/v1/dialer/parallel-calls/missed-callbacks/resolve` | [`g8.api.dialer.resolveMissedCallbacks`](dialer.md#op-resolvemissedcallbacks) | write |
|
|
1033
|
+
| PATCH | `/api/v1/dialer/parallel-calls/missed-callbacks/seen` | [`g8.api.dialer.markMissedCallbacksSeen`](dialer.md#op-markmissedcallbacksseen) | write |
|
|
1034
|
+
| PATCH | `/api/v1/dialer/parallel-calls/missed-callbacks/seen-all` | [`g8.api.dialer.markAllMissedCallbacksSeen`](dialer.md#op-markallmissedcallbacksseen) | write |
|
|
1035
|
+
| PATCH | `/api/v1/dialer/parallel-calls/missed-callbacks/unresolve` | [`g8.api.dialer.unresolveMissedCallbacks`](dialer.md#op-unresolvemissedcallbacks) | write |
|
|
1036
|
+
| GET | `/api/v1/dialer/parallel-calls/recordings/ownership` | [`g8.api.dialer.checkRecordingOwnership`](dialer.md#op-checkrecordingownership) | read |
|
|
1037
|
+
| POST | `/api/v1/dialer/parallel-calls/redial-contact` | [`g8.api.dialer.redialContact`](dialer.md#op-redialcontact) | external |
|
|
1038
|
+
| POST | `/api/v1/dialer/parallel-calls/sessions` | [`g8.api.dialer.createPausedParallelSession`](dialer.md#op-createpausedparallelsession) | write |
|
|
1039
|
+
| POST | `/api/v1/dialer/parallel-calls/sessions/start` | [`g8.api.dialer.startParallelSession`](dialer.md#op-startparallelsession) | external |
|
|
1040
|
+
| POST | `/api/v1/dialer/parallel-calls/sessions/{session_id}/calls` | [`g8.api.voice.lookupSessionCalls`](voice.md#op-lookupsessioncalls) | read |
|
|
1041
|
+
| GET | `/api/v1/dialer/parallel-calls/sessions/{session_id}/contact-ids-by-disposition` | [`g8.api.dialer.listContactIdsByDisposition`](dialer.md#op-listcontactidsbydisposition) | read |
|
|
1042
|
+
| PATCH | `/api/v1/dialer/parallel-calls/sessions/{session_id}/redial-state` | [`g8.api.dialer.updateRedialState`](dialer.md#op-updateredialstate) | write |
|
|
1043
|
+
| GET | `/api/v1/dialer/parallel-calls/targets` | [`g8.api.dialer.readOrgTargets`](dialer.md#op-readorgtargets) | read |
|
|
1044
|
+
| PUT | `/api/v1/dialer/parallel-calls/targets` | [`g8.api.dialer.setOrgTargets`](dialer.md#op-setorgtargets) | write |
|
|
1045
|
+
| GET | `/api/v1/dialer/parallel-calls/targets/all-sdrs` | [`g8.api.dialer.readAllSdrTargets`](dialer.md#op-readallsdrtargets) | read |
|
|
1046
|
+
| DELETE | `/api/v1/dialer/parallel-calls/targets/sdr` | [`g8.api.dialer.clearSdrTargets`](dialer.md#op-clearsdrtargets) | destructive |
|
|
1047
|
+
| PUT | `/api/v1/dialer/parallel-calls/targets/sdr` | [`g8.api.dialer.setSdrTargets`](dialer.md#op-setsdrtargets) | write |
|
|
1048
|
+
| GET | `/api/v1/dialer/sessions/assurance/provider-receipt` | [`g8.api.dialer.readProviderReceipt`](dialer.md#op-readproviderreceipt) | read |
|
|
1049
|
+
| POST | `/api/v1/dialer/sessions/calls/drop-voicemail` | [`g8.api.dialer.dropSessionVoicemail`](dialer.md#op-dropsessionvoicemail) | external |
|
|
1050
|
+
| POST | `/api/v1/dialer/sessions/calls/hangup` | [`g8.api.dialer.hangupSessionCall`](dialer.md#op-hangupsessioncall) | write |
|
|
1051
|
+
| POST | `/api/v1/dialer/sessions/calls/mute` | [`g8.api.dialer.muteCall`](dialer.md#op-mutecall) | write |
|
|
1052
|
+
| POST | `/api/v1/dialer/sessions/calls/{call_id}/ws-ticket` | [`g8.api.dialer.mintTranscriptWsTicket`](dialer.md#op-minttranscriptwsticket) | write |
|
|
1053
|
+
| POST | `/api/v1/dialer/sessions/draft` | [`g8.api.dialer.createSessionDraft`](dialer.md#op-createsessiondraft) | write |
|
|
1054
|
+
| POST | `/api/v1/dialer/sessions/prewarm-voicemails` | [`g8.api.dialer.prewarmVoicemails`](dialer.md#op-prewarmvoicemails) | billable |
|
|
1055
|
+
| GET | `/api/v1/dialer/sessions/token` | [`g8.api.dialer.mintSoftphoneToken`](dialer.md#op-mintsoftphonetoken) | external |
|
|
1056
|
+
| GET | `/api/v1/dialer/sessions/{session_id}` | [`g8.api.voice.getDialerSession`](voice.md#op-getdialersession) | read |
|
|
1057
|
+
| PATCH | `/api/v1/dialer/sessions/{session_id}/booking-event-type` | [`g8.api.dialer.updateSessionBookingEventType`](dialer.md#op-updatesessionbookingeventtype) | write |
|
|
1058
|
+
| POST | `/api/v1/dialer/sessions/{session_id}/calls/skip-contact` | [`g8.api.dialer.skipContact`](dialer.md#op-skipcontact) | write |
|
|
1059
|
+
| POST | `/api/v1/dialer/sessions/{session_id}/calls/unskip-contact` | [`g8.api.dialer.unskipContact`](dialer.md#op-unskipcontact) | write |
|
|
1060
|
+
| PATCH | `/api/v1/dialer/sessions/{session_id}/filter-spec` | [`g8.api.dialer.updateSessionFilter`](dialer.md#op-updatesessionfilter) | write |
|
|
1061
|
+
| POST | `/api/v1/dialer/sessions/{session_id}/grid` | [`g8.api.dialer.readSessionGrid`](dialer.md#op-readsessiongrid) | read |
|
|
1062
|
+
| PATCH | `/api/v1/dialer/sessions/{session_id}/hidden-custom-fields` | [`g8.api.dialer.updateSessionHiddenFields`](dialer.md#op-updatesessionhiddenfields) | write |
|
|
1063
|
+
| POST | `/api/v1/dialer/sessions/{session_id}/next-batch` | [`g8.api.dialer.dialNextBatch`](dialer.md#op-dialnextbatch) | external |
|
|
1064
|
+
| POST | `/api/v1/dialer/sessions/{session_id}/pause` | [`g8.api.voice.pauseDialerSession`](voice.md#op-pausedialersession) | write |
|
|
1065
|
+
| GET | `/api/v1/dialer/sessions/{session_id}/queue-stats` | [`g8.api.dialer.readQueueStats`](dialer.md#op-readqueuestats) | read |
|
|
1066
|
+
| POST | `/api/v1/dialer/sessions/{session_id}/stop` | [`g8.api.voice.stopDialerSession`](voice.md#op-stopdialersession) | write |
|
|
1067
|
+
| POST | `/api/v1/dialer/sessions/{session_id}/ws-ticket` | [`g8.api.dialer.mintSessionWsTicket`](dialer.md#op-mintsessionwsticket) | write |
|
|
1068
|
+
| PUT | `/api/v1/dialer/settings` | [`g8.api.voice.updateDialerSettings`](voice.md#op-updatedialersettings) | write |
|
|
1069
|
+
| PUT | `/api/v1/dialer/settings/preferences` | [`g8.api.dialer.setDialerPreferences`](dialer.md#op-setdialerpreferences) | write |
|
|
1070
|
+
| GET | `/api/v1/dialer/settings/preferences/{user_email}` | [`g8.api.dialer.readDialerPreferences`](dialer.md#op-readdialerpreferences) | read |
|
|
1071
|
+
| GET | `/api/v1/dialer/settings/{user_email}` | [`g8.api.voice.getDialerSettings`](voice.md#op-getdialersettings) | read |
|
|
1072
|
+
| GET | `/api/v1/dialer/transfer/departments` | [`g8.api.dialer.listTransferDepartments`](dialer.md#op-listtransferdepartments) | read |
|
|
1073
|
+
| GET | `/api/v1/dialer/transfer/{call_id}` | [`g8.api.dialer.readTransferStatus`](dialer.md#op-readtransferstatus) | read |
|
|
1074
|
+
| POST | `/api/v1/dialer/transfer/{call_id}/decline` | [`g8.api.dialer.declineTransfer`](dialer.md#op-declinetransfer) | write |
|
|
1075
|
+
| GET | `/api/v1/document-versions/{document_type}/{document_id}` | [`g8.api.studioDocuments.listDocumentVersions`](studioDocuments.md#op-listdocumentversions) | read |
|
|
1076
|
+
| GET | `/api/v1/document-versions/{document_type}/{document_id}/compare` | [`g8.api.studioDocuments.compareDocumentVersions`](studioDocuments.md#op-comparedocumentversions) | read |
|
|
1077
|
+
| GET | `/api/v1/document-versions/{document_type}/{document_id}/current` | [`g8.api.studioDocuments.getCurrentDocumentVersion`](studioDocuments.md#op-getcurrentdocumentversion) | read |
|
|
1078
|
+
| POST | `/api/v1/document-versions/{document_type}/{document_id}/revert/{version_number}` | [`g8.api.studioDocuments.revertDocumentVersion`](studioDocuments.md#op-revertdocumentversion) | write |
|
|
1079
|
+
| GET | `/api/v1/document-versions/{document_type}/{document_id}/{version_number}` | [`g8.api.studioDocuments.getDocumentVersion`](studioDocuments.md#op-getdocumentversion) | read |
|
|
1080
|
+
| GET | `/api/v1/duplicates` | [`g8.api.duplicates.listDuplicates`](duplicates.md#op-listduplicates) | read |
|
|
1081
|
+
| POST | `/api/v1/duplicates/auto-merge` | [`g8.api.contacts.triggerAutoMerge`](contacts.md#op-triggerautomerge) | destructive |
|
|
1082
|
+
| POST | `/api/v1/duplicates/bulk-merge` | [`g8.api.duplicates.startBulkMerge`](duplicates.md#op-startbulkmerge) | write |
|
|
1083
|
+
| GET | `/api/v1/duplicates/bulk-merge/{run_id}` | [`g8.api.duplicates.getBulkMergeStatus`](duplicates.md#op-getbulkmergestatus) | read |
|
|
1084
|
+
| GET | `/api/v1/duplicates/counts` | [`g8.api.duplicates.duplicateCounts`](duplicates.md#op-duplicatecounts) | read |
|
|
1085
|
+
| POST | `/api/v1/duplicates/detection/run` | [`g8.api.contacts.runDuplicateDetection`](contacts.md#op-runduplicatedetection) | write |
|
|
1086
|
+
| GET | `/api/v1/duplicates/detection/runs` | [`g8.api.contacts.listDuplicateDetectionRuns`](contacts.md#op-listduplicatedetectionruns) | read |
|
|
1087
|
+
| GET | `/api/v1/duplicates/recent-merges` | [`g8.api.duplicates.listRecentMerges`](duplicates.md#op-listrecentmerges) | read |
|
|
1088
|
+
| GET | `/api/v1/duplicates/settings` | [`g8.api.contacts.getDuplicateSettings`](contacts.md#op-getduplicatesettings) | read |
|
|
1089
|
+
| PUT | `/api/v1/duplicates/settings` | [`g8.api.contacts.updateDuplicateSettings`](contacts.md#op-updateduplicatesettings) | write |
|
|
1090
|
+
| POST | `/api/v1/duplicates/settings/preview-detection-rule` | [`g8.api.contacts.previewDetectionRule`](contacts.md#op-previewdetectionrule) | read |
|
|
1091
|
+
| POST | `/api/v1/duplicates/undo-merge/{merge_history_id}` | [`g8.api.duplicates.undoMerge`](duplicates.md#op-undomerge) | write |
|
|
1092
|
+
| POST | `/api/v1/duplicates/{suggestion_id}/reject` | [`g8.api.duplicates.rejectSuggestion`](duplicates.md#op-rejectsuggestion) | write |
|
|
1093
|
+
| POST | `/api/v1/enablement/assets` | [`g8.api.gtmContext.uploadEnablementAsset`](gtmContext.md#op-uploadenablementasset) | write |
|
|
1094
|
+
| GET | `/api/v1/enrichment/active-jobs` | [`g8.api.enrichment.listActiveEnrichmentJobs`](enrichment.md#op-listactiveenrichmentjobs) | read |
|
|
1095
|
+
| GET | `/api/v1/enrichment/ai-formula/available-fields` | [`g8.api.enrichment.listAiFormulaAvailableFields`](enrichment.md#op-listaiformulaavailablefields) | read |
|
|
1096
|
+
| POST | `/api/v1/enrichment/ai-formula/generate` | [`g8.api.enrichment.generateFormulaWithAi`](enrichment.md#op-generateformulawithai) | billable |
|
|
1097
|
+
| POST | `/api/v1/enrichment/ai-formula/generate-condition` | [`g8.api.enrichment.generateAiRunCondition`](enrichment.md#op-generateairuncondition) | billable |
|
|
1098
|
+
| POST | `/api/v1/enrichment/ai-formula/preview` | [`g8.api.enrichment.previewFormula`](enrichment.md#op-previewformula) | read |
|
|
1099
|
+
| POST | `/api/v1/enrichment/ai-formula/validate` | [`g8.api.enrichment.validateFormula`](enrichment.md#op-validateformula) | read |
|
|
1100
|
+
| GET | `/api/v1/enrichment/ai-templates` | [`g8.api.enrichment.listAiTemplates`](enrichment.md#op-listaitemplates) | read |
|
|
1101
|
+
| POST | `/api/v1/enrichment/ai/batch/enrich` | [`g8.api.enrichment.startAiBatchEnrichment`](enrichment.md#op-startaibatchenrichment) | billable |
|
|
1102
|
+
| GET | `/api/v1/enrichment/ai/batch/jobs/{job_id}/status` | [`g8.api.enrichment.getAiBatchJobStatus`](enrichment.md#op-getaibatchjobstatus) | read |
|
|
1103
|
+
| GET | `/api/v1/enrichment/ai/configs` | [`g8.api.enrichment.listAiConfigs`](enrichment.md#op-listaiconfigs) | read |
|
|
1104
|
+
| POST | `/api/v1/enrichment/ai/configs` | [`g8.api.enrichment.saveAiEnrichmentConfig`](enrichment.md#op-saveaienrichmentconfig) | write |
|
|
1105
|
+
| DELETE | `/api/v1/enrichment/ai/configs/{group_id}` | [`g8.api.enrichment.deleteAiConfigByGroup`](enrichment.md#op-deleteaiconfigbygroup) | destructive |
|
|
1106
|
+
| GET | `/api/v1/enrichment/ai/configs/{group_id}` | [`g8.api.enrichment.getAiConfiguration`](enrichment.md#op-getaiconfiguration) | read |
|
|
1107
|
+
| PUT | `/api/v1/enrichment/ai/configs/{group_id}` | [`g8.api.enrichment.updateAiConfiguration`](enrichment.md#op-updateaiconfiguration) | write |
|
|
1108
|
+
| DELETE | `/api/v1/enrichment/ai/configs/{group_id}/columns/{column_id}` | [`g8.api.enrichment.deleteAiConfigByColumn`](enrichment.md#op-deleteaiconfigbycolumn) | destructive |
|
|
1109
|
+
| PUT | `/api/v1/enrichment/ai/configs/{group_id}/rename` | [`g8.api.enrichment.renameAiEnrichmentColumn`](enrichment.md#op-renameaienrichmentcolumn) | write |
|
|
1110
|
+
| POST | `/api/v1/enrichment/ai/enrich` | [`g8.api.enrichment.runAiEnrichment`](enrichment.md#op-runaienrichment) | billable |
|
|
1111
|
+
| POST | `/api/v1/enrichment/ai/qualification/estimate` | [`g8.api.enrichment.estimateQualification`](enrichment.md#op-estimatequalification) | read |
|
|
1112
|
+
| POST | `/api/v1/enrichment/ai/qualification/estimate-all` | [`g8.api.enrichment.estimateAllQualificationTemplates`](enrichment.md#op-estimateallqualificationtemplates) | read |
|
|
1113
|
+
| GET | `/api/v1/enrichment/ai/qualification/fit-landscape` | [`g8.api.enrichment.getQualificationFitLandscape`](enrichment.md#op-getqualificationfitlandscape) | read |
|
|
1114
|
+
| POST | `/api/v1/enrichment/ai/qualification/generate-templates` | [`g8.api.enrichment.generateQualificationTemplates`](enrichment.md#op-generatequalificationtemplates) | billable |
|
|
1115
|
+
| POST | `/api/v1/enrichment/ai/qualification/run` | [`g8.api.enrichment.runQualification`](enrichment.md#op-runqualification) | billable |
|
|
1116
|
+
| GET | `/api/v1/enrichment/ai/qualification/templates` | [`g8.api.enrichment.listQualificationTemplates`](enrichment.md#op-listqualificationtemplates) | read |
|
|
1117
|
+
| PUT | `/api/v1/enrichment/ai/qualification/templates/{template_id}` | [`g8.api.enrichment.updateQualificationTemplate`](enrichment.md#op-updatequalificationtemplate) | write |
|
|
1118
|
+
| POST | `/api/v1/enrichment/ai/validate-credits` | [`g8.api.enrichment.validateAiEnrichmentCredits`](enrichment.md#op-validateaienrichmentcredits) | read |
|
|
1119
|
+
| GET | `/api/v1/enrichment/analytics/daily-activity` | [`g8.api.enrichment.getEnrichmentDailyActivity`](enrichment.md#op-getenrichmentdailyactivity) | read |
|
|
1120
|
+
| GET | `/api/v1/enrichment/analytics/field-distribution` | [`g8.api.enrichment.getEnrichmentFieldDistribution`](enrichment.md#op-getenrichmentfielddistribution) | read |
|
|
1121
|
+
| GET | `/api/v1/enrichment/analytics/metrics` | [`g8.api.enrichment.getEnrichmentMetrics`](enrichment.md#op-getenrichmentmetrics) | read |
|
|
1122
|
+
| GET | `/api/v1/enrichment/analytics/trends` | [`g8.api.enrichment.getEnrichmentTrends`](enrichment.md#op-getenrichmenttrends) | read |
|
|
1123
|
+
| GET | `/api/v1/enrichment/auto-enrichment/configs` | [`g8.api.enrichment.listAutoEnrichmentConfigs`](enrichment.md#op-listautoenrichmentconfigs) | read |
|
|
1124
|
+
| POST | `/api/v1/enrichment/auto-enrichment/configs` | [`g8.api.enrichment.createAutoEnrichmentConfig`](enrichment.md#op-createautoenrichmentconfig) | billable |
|
|
1125
|
+
| DELETE | `/api/v1/enrichment/auto-enrichment/configs/{config_id}` | [`g8.api.enrichment.deleteAutoEnrichmentConfig`](enrichment.md#op-deleteautoenrichmentconfig) | destructive |
|
|
1126
|
+
| GET | `/api/v1/enrichment/auto-enrichment/configs/{config_id}` | [`g8.api.enrichment.getAutoEnrichmentConfig`](enrichment.md#op-getautoenrichmentconfig) | read |
|
|
1127
|
+
| PATCH | `/api/v1/enrichment/auto-enrichment/configs/{config_id}` | [`g8.api.enrichment.updateAutoEnrichmentConfig`](enrichment.md#op-updateautoenrichmentconfig) | billable |
|
|
1128
|
+
| GET | `/api/v1/enrichment/auto-enrichment/settings` | [`g8.api.enrichment.getAutoEnrichmentSettings`](enrichment.md#op-getautoenrichmentsettings) | read |
|
|
1129
|
+
| PUT | `/api/v1/enrichment/auto-enrichment/settings/{entity_type}` | [`g8.api.enrichment.updateAutoEnrichmentSettings`](enrichment.md#op-updateautoenrichmentsettings) | billable |
|
|
1130
|
+
| POST | `/api/v1/enrichment/columns` | [`g8.api.enrichment.createDynamicColumn`](enrichment.md#op-createdynamiccolumn) | write |
|
|
1131
|
+
| GET | `/api/v1/enrichment/companies/gtm-profile` | [`g8.api.enrichment.getCompanyGtmProfile`](enrichment.md#op-getcompanygtmprofile) | read |
|
|
1132
|
+
| GET | `/api/v1/enrichment/configs` | [`g8.api.enrichment.listEnrichmentConfigurations`](enrichment.md#op-listenrichmentconfigurations) | read |
|
|
1133
|
+
| POST | `/api/v1/enrichment/configs` | [`g8.api.enrichment.createEnrichmentConfiguration`](enrichment.md#op-createenrichmentconfiguration) | write |
|
|
1134
|
+
| DELETE | `/api/v1/enrichment/configs/{config_id}` | [`g8.api.enrichment.deleteEnrichmentConfig`](enrichment.md#op-deleteenrichmentconfig) | destructive |
|
|
1135
|
+
| GET | `/api/v1/enrichment/configs/{config_id}` | [`g8.api.enrichment.getEnrichmentConfiguration`](enrichment.md#op-getenrichmentconfiguration) | read |
|
|
1136
|
+
| PUT | `/api/v1/enrichment/configs/{config_id}` | [`g8.api.enrichment.updateEnrichmentConfig`](enrichment.md#op-updateenrichmentconfig) | write |
|
|
1137
|
+
| GET | `/api/v1/enrichment/configs/{config_id}/assignments` | [`g8.api.enrichment.listConfigAssignments`](enrichment.md#op-listconfigassignments) | read |
|
|
1138
|
+
| POST | `/api/v1/enrichment/configs/{config_id}/assignments` | [`g8.api.enrichment.assignEnrichmentConfiguration`](enrichment.md#op-assignenrichmentconfiguration) | write |
|
|
1139
|
+
| DELETE | `/api/v1/enrichment/configs/{config_id}/assignments/{list_id}` | [`g8.api.enrichment.unassignConfigFromList`](enrichment.md#op-unassignconfigfromlist) | destructive |
|
|
1140
|
+
| POST | `/api/v1/enrichment/enrich` | [`g8.api.enrichment.startEnrichment`](enrichment.md#op-startenrichment) | billable |
|
|
1141
|
+
| POST | `/api/v1/enrichment/find-people/configure` | [`g8.api.enrichment.configureFindPeople`](enrichment.md#op-configurefindpeople) | billable |
|
|
1142
|
+
| POST | `/api/v1/enrichment/find-people/search-import` | [`g8.api.enrichment.searchImportFindPeople`](enrichment.md#op-searchimportfindpeople) | billable |
|
|
1143
|
+
| DELETE | `/api/v1/enrichment/find-people/{config_id}` | [`g8.api.enrichment.deleteFindPeopleConfig`](enrichment.md#op-deletefindpeopleconfig) | destructive |
|
|
1144
|
+
| GET | `/api/v1/enrichment/find-people/{config_id}` | [`g8.api.enrichment.getFindPeopleConfig`](enrichment.md#op-getfindpeopleconfig) | read |
|
|
1145
|
+
| PUT | `/api/v1/enrichment/find-people/{config_id}` | [`g8.api.enrichment.updateFindPeopleConfig`](enrichment.md#op-updatefindpeopleconfig) | write |
|
|
1146
|
+
| POST | `/api/v1/enrichment/find-people/{config_id}/import` | [`g8.api.enrichment.importFindPeopleResults`](enrichment.md#op-importfindpeopleresults) | billable |
|
|
1147
|
+
| POST | `/api/v1/enrichment/find-people/{config_id}/preview` | [`g8.api.enrichment.previewFindPeople`](enrichment.md#op-previewfindpeople) | billable |
|
|
1148
|
+
| GET | `/api/v1/enrichment/find-people/{config_id}/results/{company_id}` | [`g8.api.enrichment.getFindPeopleResults`](enrichment.md#op-getfindpeopleresults) | read |
|
|
1149
|
+
| POST | `/api/v1/enrichment/find-people/{config_id}/run` | [`g8.api.enrichment.runFindPeople`](enrichment.md#op-runfindpeople) | billable |
|
|
1150
|
+
| GET | `/api/v1/enrichment/formula-templates` | [`g8.api.enrichment.listFormulaTemplates`](enrichment.md#op-listformulatemplates) | read |
|
|
1151
|
+
| POST | `/api/v1/enrichment/formula-templates` | [`g8.api.enrichment.createFormulaTemplate`](enrichment.md#op-createformulatemplate) | write |
|
|
1152
|
+
| DELETE | `/api/v1/enrichment/formula/configs/{column_id}` | [`g8.api.enrichment.deleteFormulaConfig`](enrichment.md#op-deleteformulaconfig) | destructive |
|
|
1153
|
+
| GET | `/api/v1/enrichment/formula/configs/{column_id}` | [`g8.api.enrichment.getFormulaConfiguration`](enrichment.md#op-getformulaconfiguration) | read |
|
|
1154
|
+
| POST | `/api/v1/enrichment/formula/configs/{column_id}` | [`g8.api.enrichment.createFormulaConfig`](enrichment.md#op-createformulaconfig) | write |
|
|
1155
|
+
| PUT | `/api/v1/enrichment/formula/configs/{column_id}` | [`g8.api.enrichment.updateFormulaConfiguration`](enrichment.md#op-updateformulaconfiguration) | write |
|
|
1156
|
+
| POST | `/api/v1/enrichment/formula/configs/{column_id}/run` | [`g8.api.enrichment.runFormulaColumn`](enrichment.md#op-runformulacolumn) | write |
|
|
1157
|
+
| POST | `/api/v1/enrichment/generate-prompt` | [`g8.api.enrichment.generateEnrichmentPrompt`](enrichment.md#op-generateenrichmentprompt) | billable |
|
|
1158
|
+
| GET | `/api/v1/enrichment/jobs/{job_id}` | [`g8.api.enrichment.getEnrichmentJob`](enrichment.md#op-getenrichmentjob) | read |
|
|
1159
|
+
| POST | `/api/v1/enrichment/jobs/{job_id}/cancel` | [`g8.api.enrichment.cancelEnrichmentJob`](enrichment.md#op-cancelenrichmentjob) | write |
|
|
1160
|
+
| POST | `/api/v1/enrichment/jobs/{job_id}/pause` | [`g8.api.enrichment.pauseEnrichmentJob`](enrichment.md#op-pauseenrichmentjob) | write |
|
|
1161
|
+
| POST | `/api/v1/enrichment/jobs/{job_id}/resume` | [`g8.api.enrichment.resumeEnrichmentJob`](enrichment.md#op-resumeenrichmentjob) | billable |
|
|
1162
|
+
| POST | `/api/v1/enrichment/list-routing/generate-filter` | [`g8.api.enrichment.generateRoutingFilter`](enrichment.md#op-generateroutingfilter) | billable |
|
|
1163
|
+
| GET | `/api/v1/enrichment/list-routing/rules` | [`g8.api.enrichment.listRoutingRules`](enrichment.md#op-listroutingrules) | read |
|
|
1164
|
+
| POST | `/api/v1/enrichment/list-routing/rules` | [`g8.api.enrichment.createRoutingRule`](enrichment.md#op-createroutingrule) | write |
|
|
1165
|
+
| POST | `/api/v1/enrichment/list-routing/rules/preview` | [`g8.api.enrichment.previewRoutingRule`](enrichment.md#op-previewroutingrule) | read |
|
|
1166
|
+
| DELETE | `/api/v1/enrichment/list-routing/rules/{rule_id}` | [`g8.api.enrichment.deleteRoutingRule`](enrichment.md#op-deleteroutingrule) | destructive |
|
|
1167
|
+
| GET | `/api/v1/enrichment/list-routing/rules/{rule_id}` | [`g8.api.enrichment.getRoutingRule`](enrichment.md#op-getroutingrule) | read |
|
|
1168
|
+
| POST | `/api/v1/enrichment/list-routing/rules/{rule_id}/execute` | [`g8.api.enrichment.executeRoutingRule`](enrichment.md#op-executeroutingrule) | write |
|
|
1169
|
+
| GET | `/api/v1/enrichment/lists/pipeline-runs/{run_id}` | [`g8.api.enrichment.getPipelineRun`](enrichment.md#op-getpipelinerun) | read |
|
|
1170
|
+
| GET | `/api/v1/enrichment/lists/pipeline-templates` | [`g8.api.enrichment.listPipelineTemplates`](enrichment.md#op-listpipelinetemplates) | read |
|
|
1171
|
+
| GET | `/api/v1/enrichment/lists/{list_id}/pipeline-step-options` | [`g8.api.enrichment.listPipelineStepOptions`](enrichment.md#op-listpipelinestepoptions) | read |
|
|
1172
|
+
| GET | `/api/v1/enrichment/lists/{list_id}/pipelines` | [`g8.api.enrichment.listListPipelines`](enrichment.md#op-listlistpipelines) | read |
|
|
1173
|
+
| POST | `/api/v1/enrichment/lists/{list_id}/pipelines` | [`g8.api.enrichment.createListPipeline`](enrichment.md#op-createlistpipeline) | billable |
|
|
1174
|
+
| POST | `/api/v1/enrichment/lists/{list_id}/pipelines/ai-draft` | [`g8.api.enrichment.draftPipelineWithAi`](enrichment.md#op-draftpipelinewithai) | billable |
|
|
1175
|
+
| POST | `/api/v1/enrichment/lists/{list_id}/pipelines/from-template` | [`g8.api.enrichment.createListPipelineFromTemplate`](enrichment.md#op-createlistpipelinefromtemplate) | write |
|
|
1176
|
+
| DELETE | `/api/v1/enrichment/lists/{list_id}/pipelines/{pipeline_id}` | [`g8.api.enrichment.deleteListPipeline`](enrichment.md#op-deletelistpipeline) | destructive |
|
|
1177
|
+
| PUT | `/api/v1/enrichment/lists/{list_id}/pipelines/{pipeline_id}` | [`g8.api.enrichment.updateListPipeline`](enrichment.md#op-updatelistpipeline) | billable |
|
|
1178
|
+
| POST | `/api/v1/enrichment/lists/{list_id}/pipelines/{pipeline_id}/cancel` | [`g8.api.enrichment.cancelListPipelineRun`](enrichment.md#op-cancellistpipelinerun) | write |
|
|
1179
|
+
| POST | `/api/v1/enrichment/lists/{list_id}/pipelines/{pipeline_id}/enabled` | [`g8.api.enrichment.setPipelineEnabled`](enrichment.md#op-setpipelineenabled) | billable |
|
|
1180
|
+
| POST | `/api/v1/enrichment/lists/{list_id}/pipelines/{pipeline_id}/estimate` | [`g8.api.enrichment.estimateListPipeline`](enrichment.md#op-estimatelistpipeline) | read |
|
|
1181
|
+
| GET | `/api/v1/enrichment/lists/{list_id}/pipelines/{pipeline_id}/runs` | [`g8.api.enrichment.listListPipelineRuns`](enrichment.md#op-listlistpipelineruns) | read |
|
|
1182
|
+
| POST | `/api/v1/enrichment/lists/{list_id}/pipelines/{pipeline_id}/runs` | [`g8.api.enrichment.runListPipeline`](enrichment.md#op-runlistpipeline) | billable |
|
|
1183
|
+
| POST | `/api/v1/enrichment/lookup/company` | [`g8.api.enrichment.lookupCompany`](enrichment.md#op-lookupcompany) or `g8.enrich.company()` | billable |
|
|
1184
|
+
| POST | `/api/v1/enrichment/lookup/person` | [`g8.api.enrichment.lookupPerson`](enrichment.md#op-lookupperson) or `g8.enrich.person()` | billable |
|
|
1185
|
+
| POST | `/api/v1/enrichment/person` | [`g8.api.enrichment.lookupPersonAlias`](enrichment.md#op-lookuppersonalias) | billable |
|
|
1186
|
+
| GET | `/api/v1/enrichment/providers` | [`g8.api.enrichment.listEnrichmentProviders`](enrichment.md#op-listenrichmentproviders) | read |
|
|
1187
|
+
| GET | `/api/v1/enrichment/record-sync/{entity_type}/fields` | [`g8.api.enrichment.listRecordSyncFields`](enrichment.md#op-listrecordsyncfields) | read |
|
|
1188
|
+
| GET | `/api/v1/enrichment/record-sync/{entity_type}/history` | [`g8.api.enrichment.listRecordSyncHistory`](enrichment.md#op-listrecordsynchistory) | read |
|
|
1189
|
+
| GET | `/api/v1/enrichment/record-sync/{entity_type}/lists` | [`g8.api.enrichment.listRecordSyncLists`](enrichment.md#op-listrecordsynclists) | read |
|
|
1190
|
+
| PUT | `/api/v1/enrichment/record-sync/{entity_type}/policy` | [`g8.api.enrichment.updateRecordSyncPolicy`](enrichment.md#op-updaterecordsyncpolicy) | billable |
|
|
1191
|
+
| POST | `/api/v1/enrichment/record-sync/{entity_type}/preview` | [`g8.api.enrichment.previewRecordSync`](enrichment.md#op-previewrecordsync) | read |
|
|
1192
|
+
| POST | `/api/v1/enrichment/record-sync/{entity_type}/review` | [`g8.api.enrichment.reviewRecordSyncChange`](enrichment.md#op-reviewrecordsyncchange) | write |
|
|
1193
|
+
| POST | `/api/v1/enrichment/record-sync/{entity_type}/run` | [`g8.api.enrichment.runRecordSync`](enrichment.md#op-runrecordsync) | billable |
|
|
1194
|
+
| GET | `/api/v1/enrichment/record-sync/{entity_type}/status` | [`g8.api.enrichment.getRecordSyncStatus`](enrichment.md#op-getrecordsyncstatus) | read |
|
|
1195
|
+
| POST | `/api/v1/enrichment/records/progress` | [`g8.api.enrichment.getEnrichmentRecordsProgress`](enrichment.md#op-getenrichmentrecordsprogress) | read |
|
|
1196
|
+
| PATCH | `/api/v1/enrichment/records/{record_id}/fields/{column_id}` | [`g8.api.enrichment.updateEnrichmentField`](enrichment.md#op-updateenrichmentfield) | write |
|
|
1197
|
+
| POST | `/api/v1/enrichment/verify-email` | [`g8.api.enrichment.verifyEmail`](enrichment.md#op-verifyemail) or `g8.enrich.verifyEmail()` | billable |
|
|
1198
|
+
| GET | `/api/v1/enrichment/waterfall/allowed-columns` | [`g8.api.enrichment.listWaterfallAllowedColumns`](enrichment.md#op-listwaterfallallowedcolumns) | read |
|
|
1199
|
+
| GET | `/api/v1/enrichment/waterfall/configs` | [`g8.api.enrichment.listWaterfallConfigs`](enrichment.md#op-listwaterfallconfigs) | read |
|
|
1200
|
+
| POST | `/api/v1/enrichment/waterfall/configs` | [`g8.api.enrichment.createDefaultWaterfallConfig`](enrichment.md#op-createdefaultwaterfallconfig) | billable |
|
|
1201
|
+
| DELETE | `/api/v1/enrichment/waterfall/configs/{column_id}` | [`g8.api.enrichment.deleteWaterfallConfig`](enrichment.md#op-deletewaterfallconfig) | destructive |
|
|
1202
|
+
| GET | `/api/v1/enrichment/waterfall/configs/{column_id}` | [`g8.api.enrichment.getWaterfallConfiguration`](enrichment.md#op-getwaterfallconfiguration) | read |
|
|
1203
|
+
| PUT | `/api/v1/enrichment/waterfall/configs/{column_id}` | [`g8.api.enrichment.updateWaterfallConfiguration`](enrichment.md#op-updatewaterfallconfiguration) | billable |
|
|
1204
|
+
| POST | `/api/v1/enrichment/waterfall/enrich` | [`g8.api.enrichment.runWaterfallPipeline`](enrichment.md#op-runwaterfallpipeline) | billable |
|
|
1205
|
+
| GET | `/api/v1/enrichment/waterfall/jobs/{job_id}/progress` | [`g8.api.enrichment.getWaterfallJobProgress`](enrichment.md#op-getwaterfalljobprogress) | read |
|
|
1206
|
+
| GET | `/api/v1/enrichment/waterfall/templates` | [`g8.api.enrichment.listWaterfallTemplates`](enrichment.md#op-listwaterfalltemplates) | read |
|
|
1207
|
+
| POST | `/api/v1/enrichment/waterfall/validate-credits` | [`g8.api.enrichment.validateWaterfallEnrichmentCredits`](enrichment.md#op-validatewaterfallenrichmentcredits) | read |
|
|
1208
|
+
| GET | `/api/v1/envelopes` | [`g8.api.eSignature.listEnvelopes`](eSignature.md#op-listenvelopes) | read |
|
|
1209
|
+
| POST | `/api/v1/envelopes` | [`g8.api.eSignature.createEnvelope`](eSignature.md#op-createenvelope) | write |
|
|
1210
|
+
| DELETE | `/api/v1/envelopes/{envelope_id}` | [`g8.api.eSignature.deleteEnvelope`](eSignature.md#op-deleteenvelope) | destructive |
|
|
1211
|
+
| GET | `/api/v1/envelopes/{envelope_id}` | [`g8.api.eSignature.getEnvelope`](eSignature.md#op-getenvelope) | read |
|
|
1212
|
+
| GET | `/api/v1/envelopes/{envelope_id}/pdf` | [`g8.api.eSign.downloadSignedEnvelope`](eSign.md#op-downloadsignedenvelope) | read |
|
|
1213
|
+
| POST | `/api/v1/envelopes/{envelope_id}/resend` | [`g8.api.eSignature.resendEnvelope`](eSignature.md#op-resendenvelope) | external |
|
|
1214
|
+
| POST | `/api/v1/envelopes/{envelope_id}/send` | [`g8.api.eSignature.sendEnvelope`](eSignature.md#op-sendenvelope) | external |
|
|
1215
|
+
| POST | `/api/v1/envelopes/{envelope_id}/void` | [`g8.api.eSignature.voidEnvelope`](eSignature.md#op-voidenvelope) | destructive |
|
|
1216
|
+
| GET | `/api/v1/event-types` | [`g8.api.gtmLaunchHelpers.listEventTypes`](gtmLaunchHelpers.md#op-listeventtypes) | read |
|
|
1217
|
+
| GET | `/api/v1/events` | [`g8.api.events.listOrgEvents`](events.md#op-listorgevents) | read |
|
|
1218
|
+
| GET | `/api/v1/feedback/companies/{company_id}/nps` | [`g8.api.surveys.getCompanySurveyNps`](surveys.md#op-getcompanysurveynps) | read |
|
|
1219
|
+
| GET | `/api/v1/feedback/contacts/{contact_id}/history` | [`g8.api.surveys.getContactSurveyHistory`](surveys.md#op-getcontactsurveyhistory) | read |
|
|
1220
|
+
| GET | `/api/v1/feedback/org-summary` | [`g8.api.surveys.getSurveyOrgSummary`](surveys.md#op-getsurveyorgsummary) | read |
|
|
1221
|
+
| GET | `/api/v1/feedback/sending-domains` | [`g8.api.surveys.listSurveySendingDomains`](surveys.md#op-listsurveysendingdomains) | read |
|
|
1222
|
+
| GET | `/api/v1/feedback/sending-domains/status` | [`g8.api.surveys.surveyDomainStatus`](surveys.md#op-surveydomainstatus) | read |
|
|
1223
|
+
| POST | `/api/v1/feedback/sending-domains/verify` | [`g8.api.surveys.verifySurveyDomain`](surveys.md#op-verifysurveydomain) | external |
|
|
1224
|
+
| GET | `/api/v1/feedback/sends/{send_id}` | [`g8.api.surveys.getSurveySend`](surveys.md#op-getsurveysend) | read |
|
|
1225
|
+
| GET | `/api/v1/feedback/surveys` | [`g8.api.surveys.listSurveys`](surveys.md#op-listsurveys) | read |
|
|
1226
|
+
| POST | `/api/v1/feedback/surveys` | [`g8.api.surveys.createSurvey`](surveys.md#op-createsurvey) | write |
|
|
1227
|
+
| DELETE | `/api/v1/feedback/surveys/{survey_id}` | [`g8.api.surveys.deleteSurvey`](surveys.md#op-deletesurvey) | destructive |
|
|
1228
|
+
| GET | `/api/v1/feedback/surveys/{survey_id}` | [`g8.api.surveys.getSurvey`](surveys.md#op-getsurvey) | read |
|
|
1229
|
+
| PATCH | `/api/v1/feedback/surveys/{survey_id}` | [`g8.api.surveys.updateSurvey`](surveys.md#op-updatesurvey) | write |
|
|
1230
|
+
| GET | `/api/v1/feedback/surveys/{survey_id}/app-user-responses` | [`g8.api.surveys.getSurveyAppUserResponses`](surveys.md#op-getsurveyappuserresponses) | read |
|
|
1231
|
+
| GET | `/api/v1/feedback/surveys/{survey_id}/responses` | [`g8.api.surveys.getSurveyResponses`](surveys.md#op-getsurveyresponses) | read |
|
|
1232
|
+
| POST | `/api/v1/feedback/surveys/{survey_id}/send` | [`g8.api.surveys.sendSurvey`](surveys.md#op-sendsurvey) | external |
|
|
1233
|
+
| GET | `/api/v1/feedback/surveys/{survey_id}/sends` | [`g8.api.surveys.getSurveySends`](surveys.md#op-getsurveysends) | read |
|
|
1234
|
+
| GET | `/api/v1/feedback/surveys/{survey_id}/summary` | [`g8.api.surveys.getSurveySummary`](surveys.md#op-getsurveysummary) | read |
|
|
1235
|
+
| GET | `/api/v1/feedback/surveys/{survey_id}/trends` | [`g8.api.surveys.getSurveyTrends`](surveys.md#op-getsurveytrends) | read |
|
|
1236
|
+
| GET | `/api/v1/feedback/surveys/{survey_id}/triggers` | [`g8.api.surveys.listSurveyTriggers`](surveys.md#op-listsurveytriggers) | read |
|
|
1237
|
+
| POST | `/api/v1/feedback/surveys/{survey_id}/triggers` | [`g8.api.surveys.createSurveyTrigger`](surveys.md#op-createsurveytrigger) | write |
|
|
1238
|
+
| DELETE | `/api/v1/feedback/surveys/{survey_id}/triggers/{trigger_id}` | [`g8.api.surveys.deleteSurveyTrigger`](surveys.md#op-deletesurveytrigger) | destructive |
|
|
1239
|
+
| GET | `/api/v1/fields` | [`g8.api.fields.listContactFields`](fields.md#op-listcontactfields) or `g8.fields.listContactFields()` | read |
|
|
1240
|
+
| POST | `/api/v1/fields` | [`g8.api.fields.createField`](fields.md#op-createfield) or `g8.fields.create()` | write |
|
|
1241
|
+
| POST | `/api/v1/fields/batch` | [`g8.api.fields.createFieldsBatch`](fields.md#op-createfieldsbatch) | write |
|
|
1242
|
+
| GET | `/api/v1/fields/companies` | [`g8.api.fields.listCompanyFields`](fields.md#op-listcompanyfields) or `g8.fields.listCompanyFields()` | read |
|
|
1243
|
+
| PATCH | `/api/v1/fields/values/batch` | [`g8.api.fields.setFieldValuesBatch`](fields.md#op-setfieldvaluesbatch) | write |
|
|
1244
|
+
| DELETE | `/api/v1/fields/{column_id}` | [`g8.api.fields.deleteField`](fields.md#op-deletefield) or `g8.fields.delete()` | destructive |
|
|
1245
|
+
| GET | `/api/v1/fields/{column_id}/values` | [`g8.api.fields.getFieldValue`](fields.md#op-getfieldvalue) | read |
|
|
1246
|
+
| PATCH | `/api/v1/fields/{column_id}/values` | [`g8.api.fields.setFieldValue`](fields.md#op-setfieldvalue) or `g8.fields.setValue()` | write |
|
|
1247
|
+
| GET | `/api/v1/forms` | [`g8.api.forms.listForms`](forms.md#op-listforms) | read |
|
|
1248
|
+
| POST | `/api/v1/forms/deliveries/{receipt_id}/retry` | [`g8.api.forms.retryFormDelivery`](forms.md#op-retryformdelivery) | external |
|
|
1249
|
+
| GET | `/api/v1/forms/groups` | [`g8.api.forms.listFormGroups`](forms.md#op-listformgroups) | read |
|
|
1250
|
+
| POST | `/api/v1/forms/groups` | [`g8.api.forms.createFormGroup`](forms.md#op-createformgroup) | write |
|
|
1251
|
+
| DELETE | `/api/v1/forms/groups/{group_id}` | [`g8.api.forms.deleteFormGroup`](forms.md#op-deleteformgroup) | destructive |
|
|
1252
|
+
| PATCH | `/api/v1/forms/groups/{group_id}` | [`g8.api.forms.updateFormGroup`](forms.md#op-updateformgroup) | write |
|
|
1253
|
+
| POST | `/api/v1/forms/groups/{group_id}/members` | [`g8.api.forms.addFormGroupMembers`](forms.md#op-addformgroupmembers) | write |
|
|
1254
|
+
| POST | `/api/v1/forms/groups/{group_id}/members/remove` | [`g8.api.forms.removeFormGroupMembers`](forms.md#op-removeformgroupmembers) | write |
|
|
1255
|
+
| GET | `/api/v1/forms/site-audit` | [`g8.api.forms.getSiteAudit`](forms.md#op-getsiteaudit) | read |
|
|
1256
|
+
| PATCH | `/api/v1/forms/site-audit/findings/{finding_id}` | [`g8.api.forms.updateSiteAuditFinding`](forms.md#op-updatesiteauditfinding) | write |
|
|
1257
|
+
| POST | `/api/v1/forms/site-audit/scan` | [`g8.api.forms.requestSiteAuditScan`](forms.md#op-requestsiteauditscan) | write |
|
|
1258
|
+
| GET | `/api/v1/forms/unidentified/grouping` | [`g8.api.forms.previewUnidentifiedGrouping`](forms.md#op-previewunidentifiedgrouping) | read |
|
|
1259
|
+
| PUT | `/api/v1/forms/unidentified/grouping` | [`g8.api.forms.setUnidentifiedGrouping`](forms.md#op-setunidentifiedgrouping) | write |
|
|
1260
|
+
| POST | `/api/v1/forms/unidentified/groups/sync` | [`g8.api.forms.syncUnidentifiedGroup`](forms.md#op-syncunidentifiedgroup) | write |
|
|
1261
|
+
| GET | `/api/v1/forms/views/saved` | [`g8.api.forms.listSavedFormViews`](forms.md#op-listsavedformviews) | read |
|
|
1262
|
+
| PUT | `/api/v1/forms/views/saved/{view_id}` | [`g8.api.forms.saveFormView`](forms.md#op-saveformview) | write |
|
|
1263
|
+
| PATCH | `/api/v1/forms/{form_key}` | [`g8.api.forms.updateFormRegistry`](forms.md#op-updateformregistry) | write |
|
|
1264
|
+
| GET | `/api/v1/forms/{form_key}/activity` | [`g8.api.forms.getFormActivity`](forms.md#op-getformactivity) | read |
|
|
1265
|
+
| POST | `/api/v1/forms/{form_key}/backfills` | [`g8.api.forms.createFormBackfill`](forms.md#op-createformbackfill) | external |
|
|
1266
|
+
| GET | `/api/v1/forms/{form_key}/backfills/{job_id}` | [`g8.api.forms.getFormBackfill`](forms.md#op-getformbackfill) | read |
|
|
1267
|
+
| POST | `/api/v1/forms/{form_key}/delivery/pause` | [`g8.api.forms.pauseFormDelivery`](forms.md#op-pauseformdelivery) | external |
|
|
1268
|
+
| POST | `/api/v1/forms/{form_key}/delivery/resume` | [`g8.api.forms.resumeFormDelivery`](forms.md#op-resumeformdelivery) | external |
|
|
1269
|
+
| GET | `/api/v1/forms/{form_key}/fields` | [`g8.api.forms.getFormFields`](forms.md#op-getformfields) | read |
|
|
1270
|
+
| POST | `/api/v1/forms/{form_key}/mapping/preview` | [`g8.api.forms.previewFormMapping`](forms.md#op-previewformmapping) | read |
|
|
1271
|
+
| POST | `/api/v1/forms/{form_key}/mapping/save` | [`g8.api.forms.saveFormMapping`](forms.md#op-saveformmapping) | write |
|
|
1272
|
+
| GET | `/api/v1/forms/{form_key}/overview` | [`g8.api.forms.getFormOverview`](forms.md#op-getformoverview) | read |
|
|
1273
|
+
| GET | `/api/v1/forms/{form_key}/placements` | [`g8.api.forms.getFormPlacements`](forms.md#op-getformplacements) | read |
|
|
1274
|
+
| POST | `/api/v1/forms/{form_key}/preview` | [`g8.api.forms.captureFormPreview`](forms.md#op-captureformpreview) | write |
|
|
1275
|
+
| GET | `/api/v1/forms/{form_key}/preview/{preview_id}` | [`g8.api.forms.getFormPreview`](forms.md#op-getformpreview) | read |
|
|
1276
|
+
| DELETE | `/api/v1/forms/{form_key}/route` | [`g8.api.forms.rollbackFormRoute`](forms.md#op-rollbackformroute) | destructive |
|
|
1277
|
+
| PUT | `/api/v1/forms/{form_key}/route` | [`g8.api.forms.saveFormRoute`](forms.md#op-saveformroute) | write |
|
|
1278
|
+
| GET | `/api/v1/forms/{form_key}/route/recommendations` | [`g8.api.forms.getFormRouteRecommendations`](forms.md#op-getformrouterecommendations) | read |
|
|
1279
|
+
| POST | `/api/v1/forms/{form_key}/route/test` | [`g8.api.forms.testFormRoute`](forms.md#op-testformroute) | write |
|
|
1280
|
+
| POST | `/api/v1/forms/{form_key}/submissions` | [`g8.api.forms.searchFormSubmissions`](forms.md#op-searchformsubmissions) | read |
|
|
1281
|
+
| GET | `/api/v1/forms/{form_key}/submissions/{submission_id}/trace` | [`g8.api.forms.getFormSubmissionTrace`](forms.md#op-getformsubmissiontrace) | read |
|
|
1282
|
+
| GET | `/api/v1/global-context/doc/{doc_type}/highlights` | [`g8.api.gtmContext.getDocHighlights`](gtmContext.md#op-getdochighlights) | read |
|
|
1283
|
+
| DELETE | `/api/v1/global-context/documents` | [`g8.api.gtmContext.deleteAllDocuments`](gtmContext.md#op-deletealldocuments) | destructive |
|
|
1284
|
+
| GET | `/api/v1/global-context/documents` | [`g8.api.gtmContext.listGlobalContextDocuments`](gtmContext.md#op-listglobalcontextdocuments) or `g8.studio.globalContext()` | read |
|
|
1285
|
+
| GET | `/api/v1/global-context/documents/analytics` | [`g8.api.gtmContext.getDocumentsAnalytics`](gtmContext.md#op-getdocumentsanalytics) | read |
|
|
1286
|
+
| GET | `/api/v1/global-context/documents/buying-journey/crm-status` | [`g8.api.gtmContext.getBuyingJourneyCrmStatus`](gtmContext.md#op-getbuyingjourneycrmstatus) | read |
|
|
1287
|
+
| POST | `/api/v1/global-context/documents/buying-journey/interview` | [`g8.api.gtmContext.saveBuyingJourneyInterview`](gtmContext.md#op-savebuyingjourneyinterview) | write |
|
|
1288
|
+
| GET | `/api/v1/global-context/documents/{doc_id}` | [`g8.api.gtmContext.getGlobalContextDocument`](gtmContext.md#op-getglobalcontextdocument) | read |
|
|
1289
|
+
| PATCH | `/api/v1/global-context/documents/{doc_id}` | [`g8.api.gtmContext.updateGlobalContextDocument`](gtmContext.md#op-updateglobalcontextdocument) | write |
|
|
1290
|
+
| POST | `/api/v1/global-context/documents/{doc_id}/feedback` | [`g8.api.gtmContext.submitDocumentFeedback`](gtmContext.md#op-submitdocumentfeedback) | write |
|
|
1291
|
+
| POST | `/api/v1/global-context/documents/{doc_id}/track-usage` | [`g8.api.gtmContext.trackDocumentUsage`](gtmContext.md#op-trackdocumentusage) | write |
|
|
1292
|
+
| DELETE | `/api/v1/global-context/documents/{doc_type}` | [`g8.api.gtmContext.deleteDocument`](gtmContext.md#op-deletedocument) | destructive |
|
|
1293
|
+
| POST | `/api/v1/global-context/extract-company-data` | [`g8.api.gtmContext.extractCompanyData`](gtmContext.md#op-extractcompanydata) | write |
|
|
1294
|
+
| POST | `/api/v1/global-context/generate-all` | [`g8.api.gtmContext.generateAllDocuments`](gtmContext.md#op-generatealldocuments) | billable |
|
|
1295
|
+
| POST | `/api/v1/global-context/generate/{doc_type}` | [`g8.api.companyIntelligence.generateGlobalContextDocument`](companyIntelligence.md#op-generateglobalcontextdocument) | billable |
|
|
1296
|
+
| GET | `/api/v1/global-context/pipeline/latest` | [`g8.api.gtmContext.getLatestPipeline`](gtmContext.md#op-getlatestpipeline) | read |
|
|
1297
|
+
| GET | `/api/v1/global-context/pipeline/{pipeline_id}` | [`g8.api.gtmContext.getPipelineStatus`](gtmContext.md#op-getpipelinestatus) | read |
|
|
1298
|
+
| GET | `/api/v1/global-context/pipelines` | [`g8.api.gtmContext.listPipelines`](gtmContext.md#op-listpipelines) | read |
|
|
1299
|
+
| POST | `/api/v1/global-context/regenerate` | [`g8.api.gtmContext.regenerateGlobalContext`](gtmContext.md#op-regenerateglobalcontext) | write |
|
|
1300
|
+
| POST | `/api/v1/global-context/reindex-all` | [`g8.api.gtmContext.reindexAllDocuments`](gtmContext.md#op-reindexalldocuments) | write |
|
|
1301
|
+
| POST | `/api/v1/global-context/reset-stuck-documents` | [`g8.api.gtmContext.resetStuckDocuments`](gtmContext.md#op-resetstuckdocuments) | destructive |
|
|
1302
|
+
| POST | `/api/v1/global-context/resume-pipeline` | [`g8.api.gtmContext.resumePipeline`](gtmContext.md#op-resumepipeline) | write |
|
|
1303
|
+
| POST | `/api/v1/global-context/scaffold` | [`g8.api.gtmContext.scaffoldAllDocuments`](gtmContext.md#op-scaffoldalldocuments) | write |
|
|
1304
|
+
| POST | `/api/v1/global-context/scaffold-company-keywords` | [`g8.api.gtmContext.scaffoldCompanyKeywords`](gtmContext.md#op-scaffoldcompanykeywords) | write |
|
|
1305
|
+
| POST | `/api/v1/global-context/scaffold-company-profile` | [`g8.api.gtmContext.scaffoldCompanyProfile`](gtmContext.md#op-scaffoldcompanyprofile) | write |
|
|
1306
|
+
| POST | `/api/v1/global-context/stop-all-generation` | [`g8.api.gtmContext.stopAllGeneration`](gtmContext.md#op-stopallgeneration) | write |
|
|
1307
|
+
| GET | `/api/v1/global-context/tree` | [`g8.api.companyIntelligence.getGlobalContextTree`](companyIntelligence.md#op-getglobalcontexttree) | read |
|
|
1308
|
+
| GET | `/api/v1/global-context/tree/flat` | [`g8.api.companyIntelligence.getGlobalContextTreeFlat`](companyIntelligence.md#op-getglobalcontexttreeflat) | read |
|
|
1309
|
+
| POST | `/api/v1/global-context/{doc_id}/regenerate` | [`g8.api.gtmContext.regenerateOneDocument`](gtmContext.md#op-regenerateonedocument) | write |
|
|
1310
|
+
| GET | `/api/v1/health` | [`g8.api.health.apiHealth`](health.md#op-apihealth) | read |
|
|
1311
|
+
| POST | `/api/v1/hiring-signals/aggregators` | [`g8.api.signals.searchHiringAggregators`](signals.md#op-searchhiringaggregators) | billable |
|
|
1312
|
+
| POST | `/api/v1/hiring-signals/companies` | [`g8.api.signals.searchHiringCompanies`](signals.md#op-searchhiringcompanies) | billable |
|
|
1313
|
+
| POST | `/api/v1/hiring-signals/companies/job-counts` | [`g8.api.signals.getCompanyJobCounts`](signals.md#op-getcompanyjobcounts) | billable |
|
|
1314
|
+
| POST | `/api/v1/hiring-signals/companies/resolve-ids` | [`g8.api.signals.resolveHiringCompanyIds`](signals.md#op-resolvehiringcompanyids) | billable |
|
|
1315
|
+
| GET | `/api/v1/hiring-signals/companies/{linkedin_company_id}/jobs` | [`g8.api.signals.listCompanyHiringJobs`](signals.md#op-listcompanyhiringjobs) | read |
|
|
1316
|
+
| GET | `/api/v1/hiring-signals/companies/{linkedin_company_id}/linkedin-posts` | [`g8.api.signals.listCompanyLinkedinPosts`](signals.md#op-listcompanylinkedinposts) | read |
|
|
1317
|
+
| POST | `/api/v1/hiring-signals/decision-makers` | [`g8.api.signals.searchHiringDecisionMakers`](signals.md#op-searchhiringdecisionmakers) | billable |
|
|
1318
|
+
| GET | `/api/v1/hiring-signals/job-changes` | [`g8.api.signals.listJobChangeSignals`](signals.md#op-listjobchangesignals) | read |
|
|
1319
|
+
| POST | `/api/v1/hiring-signals/job-changes/match` | [`g8.api.signals.matchJobChangeSignals`](signals.md#op-matchjobchangesignals) | billable |
|
|
1320
|
+
| POST | `/api/v1/hiring-signals/jobs` | [`g8.api.signals.searchHiringJobs`](signals.md#op-searchhiringjobs) | billable |
|
|
1321
|
+
| GET | `/api/v1/hiring-signals/jobs/{job_id}` | [`g8.api.signals.getHiringJobDetails`](signals.md#op-gethiringjobdetails) | read |
|
|
1322
|
+
| POST | `/api/v1/hiring-signals/recruiters` | [`g8.api.signals.searchHiringRecruiters`](signals.md#op-searchhiringrecruiters) | billable |
|
|
1323
|
+
| GET | `/api/v1/icps` | [`g8.api.gtmContext.listIcps`](gtmContext.md#op-listicps) or `g8.studio.icps()` | read |
|
|
1324
|
+
| POST | `/api/v1/icps` | [`g8.api.gtmContext.createIcp`](gtmContext.md#op-createicp) or `g8.studio.createIcp()` | write |
|
|
1325
|
+
| POST | `/api/v1/icps/generate` | [`g8.api.gtmLibrary.generateIcps`](gtmLibrary.md#op-generateicps) | billable |
|
|
1326
|
+
| PATCH | `/api/v1/icps/{icp_id}` | [`g8.api.gtmContext.updateIcp`](gtmContext.md#op-updateicp) or `g8.studio.updateIcp()` | write |
|
|
1327
|
+
| POST | `/api/v1/icps/{icp_id}/archive` | [`g8.api.gtmContext.archiveIcp`](gtmContext.md#op-archiveicp) or `g8.studio.archiveIcp()` | destructive |
|
|
1328
|
+
| POST | `/api/v1/icps/{icp_id}/pin` | [`g8.api.gtmLibrary.pinIcp`](gtmLibrary.md#op-pinicp) | write |
|
|
1329
|
+
| POST | `/api/v1/icps/{icp_id}/unpin` | [`g8.api.gtmLibrary.unpinIcp`](gtmLibrary.md#op-unpinicp) | write |
|
|
1330
|
+
| GET | `/api/v1/image-library` | [`g8.api.imageLibrary.listLibraryImages`](imageLibrary.md#op-listlibraryimages) | read |
|
|
1331
|
+
| GET | `/api/v1/image-library/categories` | [`g8.api.imageLibrary.listLibraryImageCategories`](imageLibrary.md#op-listlibraryimagecategories) | read |
|
|
1332
|
+
| POST | `/api/v1/image-library/duplicates/merge` | [`g8.api.imageLibrary.mergeLibraryDuplicates`](imageLibrary.md#op-mergelibraryduplicates) | write |
|
|
1333
|
+
| POST | `/api/v1/image-library/duplicates/scan` | [`g8.api.imageLibrary.scanLibraryDuplicates`](imageLibrary.md#op-scanlibraryduplicates) | read |
|
|
1334
|
+
| POST | `/api/v1/image-library/extract` | [`g8.api.imageLibrary.extractImagesFromWebsite`](imageLibrary.md#op-extractimagesfromwebsite) | write |
|
|
1335
|
+
| POST | `/api/v1/image-library/extract-all-pages` | [`g8.api.imageLibrary.extractImagesFromAllPages`](imageLibrary.md#op-extractimagesfromallpages) | write |
|
|
1336
|
+
| GET | `/api/v1/image-library/extract/status/{task_id}` | [`g8.api.imageLibrary.getImageExtractionStatus`](imageLibrary.md#op-getimageextractionstatus) | read |
|
|
1337
|
+
| DELETE | `/api/v1/image-library/generated/{image_id}` | [`g8.api.imageLibrary.discardGeneratedImage`](imageLibrary.md#op-discardgeneratedimage) | destructive |
|
|
1338
|
+
| POST | `/api/v1/image-library/generated/{image_id}/commit` | [`g8.api.imageLibrary.commitGeneratedImage`](imageLibrary.md#op-commitgeneratedimage) | write |
|
|
1339
|
+
| DELETE | `/api/v1/image-library/{image_id}` | [`g8.api.imageLibrary.deleteLibraryImage`](imageLibrary.md#op-deletelibraryimage) | destructive |
|
|
1340
|
+
| PATCH | `/api/v1/image-library/{image_id}/alt-text` | [`g8.api.imageLibrary.setLibraryImageAltText`](imageLibrary.md#op-setlibraryimagealttext) | write |
|
|
1341
|
+
| PATCH | `/api/v1/image-library/{image_id}/category` | [`g8.api.imageLibrary.setLibraryImageCategory`](imageLibrary.md#op-setlibraryimagecategory) | write |
|
|
1342
|
+
| PATCH | `/api/v1/image-library/{image_id}/feedback` | [`g8.api.imageLibrary.setLibraryImageFeedback`](imageLibrary.md#op-setlibraryimagefeedback) | write |
|
|
1343
|
+
| PATCH | `/api/v1/image-library/{image_id}/tags` | [`g8.api.imageLibrary.setLibraryImageTags`](imageLibrary.md#op-setlibraryimagetags) | write |
|
|
1344
|
+
| POST | `/api/v1/imports` | [`g8.api.imports.uploadImportFile`](imports.md#op-uploadimportfile) | write |
|
|
1345
|
+
| POST | `/api/v1/imports/{import_id}/contacts` | [`g8.api.imports.importContacts`](imports.md#op-importcontacts) | write |
|
|
1346
|
+
| POST | `/api/v1/imports/{import_id}/preview` | [`g8.api.imports.previewImportFile`](imports.md#op-previewimportfile) | read |
|
|
1347
|
+
| GET | `/api/v1/inbox` | [`g8.api.inbox.listInbox`](inbox.md#op-listinbox) or `g8.inbox.list()` | read |
|
|
1348
|
+
| POST | `/api/v1/inbox/agents` | [`g8.api.aiInbox.createInboxAgent`](aiInbox.md#op-createinboxagent) | write |
|
|
1349
|
+
| GET | `/api/v1/inbox/attachments/{token}` | [`g8.api.aiInbox.downloadInboxAttachment`](aiInbox.md#op-downloadinboxattachment) | read |
|
|
1350
|
+
| GET | `/api/v1/inbox/blocked-senders` | [`g8.api.aiInbox.listInboxBlockedSenders`](aiInbox.md#op-listinboxblockedsenders) | read |
|
|
1351
|
+
| POST | `/api/v1/inbox/blocked-senders` | [`g8.api.aiInbox.blockInboxSender`](aiInbox.md#op-blockinboxsender) | write |
|
|
1352
|
+
| DELETE | `/api/v1/inbox/blocked-senders/{blocked_sender_id}` | [`g8.api.aiInbox.unblockInboxSender`](aiInbox.md#op-unblockinboxsender) | destructive |
|
|
1353
|
+
| POST | `/api/v1/inbox/call-results/search` | [`g8.api.aiInbox.searchInboxCallResults`](aiInbox.md#op-searchinboxcallresults) | read |
|
|
1354
|
+
| GET | `/api/v1/inbox/call-results/{call_id}` | [`g8.api.aiInbox.getInboxCallResult`](aiInbox.md#op-getinboxcallresult) | read |
|
|
1355
|
+
| GET | `/api/v1/inbox/channels/{channel_id}` | [`g8.api.aiInbox.getInboxChannel`](aiInbox.md#op-getinboxchannel) | read |
|
|
1356
|
+
| POST | `/api/v1/inbox/channels/{channel_id}/ai-pause` | [`g8.api.aiInbox.setChannelAiPause`](aiInbox.md#op-setchannelaipause) | write |
|
|
1357
|
+
| DELETE | `/api/v1/inbox/channels/{channel_id}/assign` | [`g8.api.aiInbox.unassignChannel`](aiInbox.md#op-unassignchannel) | destructive |
|
|
1358
|
+
| POST | `/api/v1/inbox/channels/{channel_id}/assign` | [`g8.api.aiInbox.assignChannel`](aiInbox.md#op-assignchannel) | write |
|
|
1359
|
+
| GET | `/api/v1/inbox/channels/{channel_id}/assignee-eligibility` | [`g8.api.aiInbox.getAssigneeEligibility`](aiInbox.md#op-getassigneeeligibility) | read |
|
|
1360
|
+
| GET | `/api/v1/inbox/channels/{channel_id}/comments` | [`g8.api.aiInbox.listChannelComments`](aiInbox.md#op-listchannelcomments) | read |
|
|
1361
|
+
| POST | `/api/v1/inbox/channels/{channel_id}/comments` | [`g8.api.aiInbox.addChannelComment`](aiInbox.md#op-addchannelcomment) | write |
|
|
1362
|
+
| DELETE | `/api/v1/inbox/channels/{channel_id}/tags` | [`g8.api.aiInbox.removeChannelTag`](aiInbox.md#op-removechanneltag) | destructive |
|
|
1363
|
+
| POST | `/api/v1/inbox/channels/{channel_id}/tags` | [`g8.api.aiInbox.addChannelTag`](aiInbox.md#op-addchanneltag) | write |
|
|
1364
|
+
| POST | `/api/v1/inbox/chats/auto-tag` | [`g8.api.inbox.autoTagInboxChat`](inbox.md#op-autotaginboxchat) | write |
|
|
1365
|
+
| POST | `/api/v1/inbox/chats/search` | [`g8.api.inbox.searchInboxChats`](inbox.md#op-searchinboxchats) | read |
|
|
1366
|
+
| GET | `/api/v1/inbox/chats/{chat_id}` | [`g8.api.inbox.getInboxChat`](inbox.md#op-getinboxchat) | read |
|
|
1367
|
+
| POST | `/api/v1/inbox/chats/{chat_id}/mark-viewed` | [`g8.api.inbox.markInboxChatViewed`](inbox.md#op-markinboxchatviewed) | write |
|
|
1368
|
+
| PUT | `/api/v1/inbox/chats/{chat_id}/star` | [`g8.api.inbox.starInboxChat`](inbox.md#op-starinboxchat) | write |
|
|
1369
|
+
| POST | `/api/v1/inbox/drafts/attachments` | [`g8.api.aiInbox.uploadInboxDraftAttachment`](aiInbox.md#op-uploadinboxdraftattachment) | write |
|
|
1370
|
+
| DELETE | `/api/v1/inbox/drafts/emails/{draft_id}` | [`g8.api.aiInbox.deleteInboxEmailDraft`](aiInbox.md#op-deleteinboxemaildraft) | destructive |
|
|
1371
|
+
| POST | `/api/v1/inbox/drafts/generate` | [`g8.api.aiInbox.generateInboxDraft`](aiInbox.md#op-generateinboxdraft) | billable |
|
|
1372
|
+
| GET | `/api/v1/inbox/email-settings` | [`g8.api.aiInbox.getInboxEmailSettings`](aiInbox.md#op-getinboxemailsettings) | read |
|
|
1373
|
+
| PUT | `/api/v1/inbox/email-settings` | [`g8.api.aiInbox.setInboxEmailSettings`](aiInbox.md#op-setinboxemailsettings) | write |
|
|
1374
|
+
| GET | `/api/v1/inbox/email-settings/timezones` | [`g8.api.aiInbox.listInboxEmailSettingsTimezones`](aiInbox.md#op-listinboxemailsettingstimezones) | read |
|
|
1375
|
+
| GET | `/api/v1/inbox/emails/by-sequence/{sequence_id}` | [`g8.api.aiInbox.listInboxEmailsBySequence`](aiInbox.md#op-listinboxemailsbysequence) | read |
|
|
1376
|
+
| POST | `/api/v1/inbox/emails/compose` | [`g8.api.aiInbox.composeInboxEmail`](aiInbox.md#op-composeinboxemail) | external |
|
|
1377
|
+
| POST | `/api/v1/inbox/emails/search` | [`g8.api.inbox.searchInboxEmails`](inbox.md#op-searchinboxemails) | read |
|
|
1378
|
+
| POST | `/api/v1/inbox/emails/validate-mailbox` | [`g8.api.aiInbox.validateInboxSendMailbox`](aiInbox.md#op-validateinboxsendmailbox) | read |
|
|
1379
|
+
| GET | `/api/v1/inbox/emails/{email_id}` | [`g8.api.inbox.getInboxEmail`](inbox.md#op-getinboxemail) | read |
|
|
1380
|
+
| DELETE | `/api/v1/inbox/emails/{email_id}/draft` | [`g8.api.inbox.discardInboxEmailDraft`](inbox.md#op-discardinboxemaildraft) | destructive |
|
|
1381
|
+
| POST | `/api/v1/inbox/emails/{email_id}/link-sequence` | [`g8.api.aiInbox.linkInboxEmailToSequence`](aiInbox.md#op-linkinboxemailtosequence) | write |
|
|
1382
|
+
| POST | `/api/v1/inbox/emails/{email_id}/mark-read` | [`g8.api.aiInbox.markInboxEmailRead`](aiInbox.md#op-markinboxemailread) | write |
|
|
1383
|
+
| POST | `/api/v1/inbox/emails/{email_id}/send` | [`g8.api.inbox.sendInboxEmail`](inbox.md#op-sendinboxemail) | external |
|
|
1384
|
+
| POST | `/api/v1/inbox/emails/{email_id}/sequence` | [`g8.api.aiInbox.setInboxEmailSequence`](aiInbox.md#op-setinboxemailsequence) | write |
|
|
1385
|
+
| GET | `/api/v1/inbox/emails/{email_id}/sequence-candidates` | [`g8.api.aiInbox.listInboxEmailSequenceCandidates`](aiInbox.md#op-listinboxemailsequencecandidates) | read |
|
|
1386
|
+
| GET | `/api/v1/inbox/hot-contacts` | [`g8.api.inbox.hotContacts`](inbox.md#op-hotcontacts) | read |
|
|
1387
|
+
| GET | `/api/v1/inbox/linkedin/accounts` | [`g8.api.aiInbox.listInboxLinkedinAccounts`](aiInbox.md#op-listinboxlinkedinaccounts) | read |
|
|
1388
|
+
| POST | `/api/v1/inbox/linkedin/accounts/sync` | [`g8.api.aiInbox.syncInboxLinkedinAccounts`](aiInbox.md#op-syncinboxlinkedinaccounts) | external |
|
|
1389
|
+
| GET | `/api/v1/inbox/linkedin/accounts/{account_id}` | [`g8.api.aiInbox.getInboxLinkedinAccount`](aiInbox.md#op-getinboxlinkedinaccount) | read |
|
|
1390
|
+
| PUT | `/api/v1/inbox/linkedin/accounts/{account_id}` | [`g8.api.aiInbox.updateInboxLinkedinAccount`](aiInbox.md#op-updateinboxlinkedinaccount) | external |
|
|
1391
|
+
| GET | `/api/v1/inbox/linkedin/accounts/{account_id}/conversations/{conversation_id}` | [`g8.api.aiInbox.getInboxLinkedinConversation`](aiInbox.md#op-getinboxlinkedinconversation) | read |
|
|
1392
|
+
| GET | `/api/v1/inbox/linkedin/accounts/{account_id}/conversations/{conversation_id}/detail` | [`g8.api.aiInbox.getInboxLinkedinConversationDetail`](aiInbox.md#op-getinboxlinkedinconversationdetail) | read |
|
|
1393
|
+
| DELETE | `/api/v1/inbox/linkedin/accounts/{account_id}/conversations/{conversation_id}/draft` | [`g8.api.aiInbox.deleteInboxLinkedinDraft`](aiInbox.md#op-deleteinboxlinkedindraft) | destructive |
|
|
1394
|
+
| POST | `/api/v1/inbox/linkedin/accounts/{account_id}/conversations/{conversation_id}/read` | [`g8.api.aiInbox.markInboxLinkedinConversationRead`](aiInbox.md#op-markinboxlinkedinconversationread) | write |
|
|
1395
|
+
| POST | `/api/v1/inbox/linkedin/accounts/{account_id}/conversations/{conversation_id}/unread` | [`g8.api.aiInbox.markInboxLinkedinConversationUnread`](aiInbox.md#op-markinboxlinkedinconversationunread) | write |
|
|
1396
|
+
| POST | `/api/v1/inbox/linkedin/accounts/{account_id}/disable` | [`g8.api.aiInbox.disableInboxLinkedinAccount`](aiInbox.md#op-disableinboxlinkedinaccount) | write |
|
|
1397
|
+
| POST | `/api/v1/inbox/linkedin/accounts/{account_id}/enable` | [`g8.api.aiInbox.enableInboxLinkedinAccount`](aiInbox.md#op-enableinboxlinkedinaccount) | external |
|
|
1398
|
+
| POST | `/api/v1/inbox/linkedin/compose` | [`g8.api.aiInbox.composeInboxLinkedinMessage`](aiInbox.md#op-composeinboxlinkedinmessage) | external |
|
|
1399
|
+
| POST | `/api/v1/inbox/linkedin/conversations/search` | [`g8.api.aiInbox.searchInboxLinkedinConversations`](aiInbox.md#op-searchinboxlinkedinconversations) | read |
|
|
1400
|
+
| POST | `/api/v1/inbox/linkedin/validate-account` | [`g8.api.aiInbox.validateInboxLinkedinAccount`](aiInbox.md#op-validateinboxlinkedinaccount) | read |
|
|
1401
|
+
| GET | `/api/v1/inbox/mailboxes` | [`g8.api.aiInbox.listInboxMailboxes`](aiInbox.md#op-listinboxmailboxes) | read |
|
|
1402
|
+
| POST | `/api/v1/inbox/mailboxes/activate` | [`g8.api.aiInbox.activateInboxMailboxes`](aiInbox.md#op-activateinboxmailboxes) | external |
|
|
1403
|
+
| GET | `/api/v1/inbox/mailboxes/all` | [`g8.api.aiInbox.listAllInboxMailboxes`](aiInbox.md#op-listallinboxmailboxes) | read |
|
|
1404
|
+
| POST | `/api/v1/inbox/mailboxes/associated-sequences` | [`g8.api.aiInbox.listMailboxAssociatedSequences`](aiInbox.md#op-listmailboxassociatedsequences) | read |
|
|
1405
|
+
| PATCH | `/api/v1/inbox/mailboxes/bulk` | [`g8.api.aiInbox.toggleInboxMailboxes`](aiInbox.md#op-toggleinboxmailboxes) | external |
|
|
1406
|
+
| POST | `/api/v1/inbox/mailboxes/deactivate` | [`g8.api.aiInbox.deactivateInboxMailboxes`](aiInbox.md#op-deactivateinboxmailboxes) | write |
|
|
1407
|
+
| GET | `/api/v1/inbox/mailboxes/paginated` | [`g8.api.aiInbox.listInboxMailboxesPaginated`](aiInbox.md#op-listinboxmailboxespaginated) | read |
|
|
1408
|
+
| POST | `/api/v1/inbox/mailboxes/{mailbox}/revalidate` | [`g8.api.aiInbox.revalidateInboxMailbox`](aiInbox.md#op-revalidateinboxmailbox) | write |
|
|
1409
|
+
| PATCH | `/api/v1/inbox/mailboxes/{mailbox}/settings` | [`g8.api.aiInbox.updateInboxMailboxSettings`](aiInbox.md#op-updateinboxmailboxsettings) | external |
|
|
1410
|
+
| DELETE | `/api/v1/inbox/mailboxes/{mailbox}/sync` | [`g8.api.aiInbox.stopInboxMailboxSync`](aiInbox.md#op-stopinboxmailboxsync) | destructive |
|
|
1411
|
+
| GET | `/api/v1/inbox/mailboxes/{mailbox}/sync` | [`g8.api.aiInbox.getInboxMailboxSync`](aiInbox.md#op-getinboxmailboxsync) | read |
|
|
1412
|
+
| POST | `/api/v1/inbox/mailboxes/{mailbox}/sync` | [`g8.api.aiInbox.startInboxMailboxSync`](aiInbox.md#op-startinboxmailboxsync) | external |
|
|
1413
|
+
| PATCH | `/api/v1/inbox/mailboxes/{mailbox}/visibility` | [`g8.api.aiInbox.setInboxMailboxVisibility`](aiInbox.md#op-setinboxmailboxvisibility) | write |
|
|
1414
|
+
| GET | `/api/v1/inbox/meetings` | [`g8.api.meetings.listMeetings`](meetings.md#op-listmeetings) or `g8.meetings.list()` | read |
|
|
1415
|
+
| GET | `/api/v1/inbox/meetings/booked` | [`g8.api.meetings.meetingsBooked`](meetings.md#op-meetingsbooked) | read |
|
|
1416
|
+
| GET | `/api/v1/inbox/meetings/my-tasks` | [`g8.api.aiInbox.listMyMeetingTasks`](aiInbox.md#op-listmymeetingtasks) | read |
|
|
1417
|
+
| DELETE | `/api/v1/inbox/meetings/tasks/{task_id}` | [`g8.api.aiInbox.deleteMeetingTask`](aiInbox.md#op-deletemeetingtask) | destructive |
|
|
1418
|
+
| PATCH | `/api/v1/inbox/meetings/tasks/{task_id}` | [`g8.api.aiInbox.updateMeetingTask`](aiInbox.md#op-updatemeetingtask) | write |
|
|
1419
|
+
| GET | `/api/v1/inbox/meetings/{meeting_id}` | [`g8.api.meetings.getMeeting`](meetings.md#op-getmeeting) or `g8.meetings.get()` | read |
|
|
1420
|
+
| GET | `/api/v1/inbox/meetings/{meeting_id}/assignable-users` | [`g8.api.aiInbox.listAssignableMeetingUsers`](aiInbox.md#op-listassignablemeetingusers) | read |
|
|
1421
|
+
| POST | `/api/v1/inbox/meetings/{meeting_id}/no-transcript` | [`g8.api.aiInbox.markMeetingNoTranscriptExpected`](aiInbox.md#op-markmeetingnotranscriptexpected) | write |
|
|
1422
|
+
| PATCH | `/api/v1/inbox/meetings/{meeting_id}/sensitivity` | [`g8.api.aiInbox.setMeetingSensitivity`](aiInbox.md#op-setmeetingsensitivity) | destructive |
|
|
1423
|
+
| GET | `/api/v1/inbox/meetings/{meeting_id}/tasks` | [`g8.api.aiInbox.listMeetingTasks`](aiInbox.md#op-listmeetingtasks) | read |
|
|
1424
|
+
| POST | `/api/v1/inbox/meetings/{meeting_id}/tasks` | [`g8.api.aiInbox.createMeetingTask`](aiInbox.md#op-createmeetingtask) | write |
|
|
1425
|
+
| DELETE | `/api/v1/inbox/meetings/{meeting_id}/transcript-link` | [`g8.api.aiInbox.clearMeetingTranscriptLink`](aiInbox.md#op-clearmeetingtranscriptlink) | destructive |
|
|
1426
|
+
| POST | `/api/v1/inbox/meetings/{meeting_id}/transcript-link` | [`g8.api.aiInbox.linkMeetingTranscript`](aiInbox.md#op-linkmeetingtranscript) | write |
|
|
1427
|
+
| POST | `/api/v1/inbox/notes/attachments` | [`g8.api.aiInbox.uploadInboxNoteAttachment`](aiInbox.md#op-uploadinboxnoteattachment) | write |
|
|
1428
|
+
| POST | `/api/v1/inbox/sms/compose` | [`g8.api.aiInbox.composeInboxSms`](aiInbox.md#op-composeinboxsms) | external |
|
|
1429
|
+
| POST | `/api/v1/inbox/sms/{thread_id}/mark-read` | [`g8.api.aiInbox.markInboxSmsRead`](aiInbox.md#op-markinboxsmsread) | write |
|
|
1430
|
+
| POST | `/api/v1/inbox/tags` | [`g8.api.aiInbox.createInboxTag`](aiInbox.md#op-createinboxtag) | write |
|
|
1431
|
+
| DELETE | `/api/v1/inbox/tags/{tag_id}` | [`g8.api.aiInbox.deleteInboxTag`](aiInbox.md#op-deleteinboxtag) | destructive |
|
|
1432
|
+
| PUT | `/api/v1/inbox/tags/{tag_id}` | [`g8.api.aiInbox.updateInboxTag`](aiInbox.md#op-updateinboxtag) | write |
|
|
1433
|
+
| GET | `/api/v1/inbox/tags/{tag_id}/agent` | [`g8.api.aiInbox.getInboxTagAgent`](aiInbox.md#op-getinboxtagagent) | read |
|
|
1434
|
+
| GET | `/api/v1/inbox/users` | [`g8.api.aiInbox.listInboxUsers`](aiInbox.md#op-listinboxusers) | read |
|
|
1435
|
+
| GET | `/api/v1/inbox/workspaces` | [`g8.api.aiInbox.listInboxWorkspaces`](aiInbox.md#op-listinboxworkspaces) | read |
|
|
1436
|
+
| GET | `/api/v1/inbox/workspaces/sequence-channels/{sequence_id}` | [`g8.api.aiInbox.getSequenceChannels`](aiInbox.md#op-getsequencechannels) | read |
|
|
1437
|
+
| GET | `/api/v1/inbox/workspaces/unread-counts` | [`g8.api.aiInbox.getWorkspaceUnreadCounts`](aiInbox.md#op-getworkspaceunreadcounts) | read |
|
|
1438
|
+
| GET | `/api/v1/inbox/workspaces/{workspace_id}` | [`g8.api.aiInbox.getInboxWorkspace`](aiInbox.md#op-getinboxworkspace) | read |
|
|
1439
|
+
| POST | `/api/v1/inbox/workspaces/{workspace_id}/mailboxes` | [`g8.api.aiInbox.addMailboxToWorkspace`](aiInbox.md#op-addmailboxtoworkspace) | write |
|
|
1440
|
+
| GET | `/api/v1/inbox/{reply_id}` | [`g8.api.inbox.getReply`](inbox.md#op-getreply) or `g8.inbox.get()` | read |
|
|
1441
|
+
| POST | `/api/v1/inbox/{reply_id}/assign` | [`g8.api.inbox.assignReply`](inbox.md#op-assignreply) or `g8.inbox.assign()` | external |
|
|
1442
|
+
| GET | `/api/v1/inbox/{reply_id}/draft` | [`g8.api.inbox.getDraft`](inbox.md#op-getdraft) or `g8.inbox.draft()` | read |
|
|
1443
|
+
| POST | `/api/v1/inbox/{reply_id}/send` | [`g8.api.inbox.sendReply`](inbox.md#op-sendreply) or `g8.inbox.send()` | external |
|
|
1444
|
+
| POST | `/api/v1/inbox/{reply_id}/tag` | [`g8.api.inbox.tagReply`](inbox.md#op-tagreply) or `g8.inbox.tag()` | external |
|
|
1445
|
+
| GET | `/api/v1/installed-apps` | [`g8.api.installedApps.listInstalledApps`](installedApps.md#op-listinstalledapps) | read |
|
|
1446
|
+
| POST | `/api/v1/installed-apps` | [`g8.api.installedApps.installApp`](installedApps.md#op-installapp) | write |
|
|
1447
|
+
| DELETE | `/api/v1/installed-apps/{app_id}` | [`g8.api.installedApps.uninstallApp`](installedApps.md#op-uninstallapp) | destructive |
|
|
1448
|
+
| GET | `/api/v1/installed-apps/{app_id}` | [`g8.api.installedApps.getInstalledApp`](installedApps.md#op-getinstalledapp) | read |
|
|
1449
|
+
| GET | `/api/v1/integrations/connections` | [`g8.api.integrations.listConnections`](integrations.md#op-listconnections) | read |
|
|
1450
|
+
| POST | `/api/v1/integrations/connections` | [`g8.api.integrations.saveConnection`](integrations.md#op-saveconnection) | external |
|
|
1451
|
+
| POST | `/api/v1/integrations/connections/session-token` | [`g8.api.integrations.createConnectionSessionToken`](integrations.md#op-createconnectionsessiontoken) | external |
|
|
1452
|
+
| DELETE | `/api/v1/integrations/connections/{connection_id}` | [`g8.api.integrations.deleteConnection`](integrations.md#op-deleteconnection) | destructive |
|
|
1453
|
+
| GET | `/api/v1/integrations/connections/{connection_id}/last-migration` | [`g8.api.integrations.getLastCompletedMigration`](integrations.md#op-getlastcompletedmigration) | read |
|
|
1454
|
+
| POST | `/api/v1/integrations/crm-sync/audiences` | [`g8.api.integrations.getOrCreateCrmAudience`](integrations.md#op-getorcreatecrmaudience) | external |
|
|
1455
|
+
| POST | `/api/v1/integrations/crm-sync/contacts/pull` | [`g8.api.integrations.pullAllContacts`](integrations.md#op-pullallcontacts) | external |
|
|
1456
|
+
| POST | `/api/v1/integrations/crm-sync/contacts/push` | [`g8.api.integrations.pushAllContacts`](integrations.md#op-pushallcontacts) | external |
|
|
1457
|
+
| POST | `/api/v1/integrations/crm-sync/deals/pull` | [`g8.api.integrations.pullAllDeals`](integrations.md#op-pullalldeals) | external |
|
|
1458
|
+
| POST | `/api/v1/integrations/crm-sync/deals/push` | [`g8.api.integrations.pushAllDeals`](integrations.md#op-pushalldeals) | external |
|
|
1459
|
+
| GET | `/api/v1/integrations/crm-sync/jobs/{job_id}` | [`g8.api.integrations.getSyncJob`](integrations.md#op-getsyncjob) | read |
|
|
1460
|
+
| POST | `/api/v1/integrations/crm-sync/leads/previews` | [`g8.api.integrations.startLeadPreview`](integrations.md#op-startleadpreview) | external |
|
|
1461
|
+
| POST | `/api/v1/integrations/crm-sync/leads/pull` | [`g8.api.integrations.pullAllLeads`](integrations.md#op-pullallleads) | external |
|
|
1462
|
+
| POST | `/api/v1/integrations/crm-sync/leads/push` | [`g8.api.integrations.pushAllLeads`](integrations.md#op-pushallleads) | external |
|
|
1463
|
+
| GET | `/api/v1/integrations/crm-sync/leads/push-preview` | [`g8.api.integrations.previewLeadPush`](integrations.md#op-previewleadpush) | read |
|
|
1464
|
+
| GET | `/api/v1/integrations/crm-sync/leads/statuses` | [`g8.api.integrations.listLeadStatuses`](integrations.md#op-listleadstatuses) | read |
|
|
1465
|
+
| POST | `/api/v1/integrations/crm-sync/pull` | [`g8.api.integrations.pullCrmList`](integrations.md#op-pullcrmlist) | external |
|
|
1466
|
+
| PUT | `/api/v1/integrations/crm-sync/pull-enabled` | [`g8.api.integrations.setPullSyncEnabled`](integrations.md#op-setpullsyncenabled) | external |
|
|
1467
|
+
| POST | `/api/v1/integrations/crm-sync/push` | [`g8.api.integrations.pushAudience`](integrations.md#op-pushaudience) | external |
|
|
1468
|
+
| PUT | `/api/v1/integrations/crm-sync/push-enabled` | [`g8.api.integrations.setPushSyncEnabled`](integrations.md#op-setpushsyncenabled) | external |
|
|
1469
|
+
| GET | `/api/v1/integrations/crm/activities` | [`g8.api.integrations.listCrmActivities`](integrations.md#op-listcrmactivities) | read |
|
|
1470
|
+
| GET | `/api/v1/integrations/crm/company-activities` | [`g8.api.integrations.listCompanyActivitiesByGraph8Id`](integrations.md#op-listcompanyactivitiesbygraph8id) | read |
|
|
1471
|
+
| GET | `/api/v1/integrations/crm/connections/{connection_id}` | [`g8.api.integrations.getCrmConnection`](integrations.md#op-getcrmconnection) | read |
|
|
1472
|
+
| POST | `/api/v1/integrations/crm/connections/{connection_id}/batch/contacts` | [`g8.api.integrations.batchCreateCrmContacts`](integrations.md#op-batchcreatecrmcontacts) | external |
|
|
1473
|
+
| PUT | `/api/v1/integrations/crm/connections/{connection_id}/batch/contacts` | [`g8.api.integrations.batchUpdateCrmContacts`](integrations.md#op-batchupdatecrmcontacts) | external |
|
|
1474
|
+
| POST | `/api/v1/integrations/crm/connections/{connection_id}/batch/contacts/lookup-by-email` | [`g8.api.integrations.lookupCrmContactsByEmail`](integrations.md#op-lookupcrmcontactsbyemail) | read |
|
|
1475
|
+
| GET | `/api/v1/integrations/crm/connections/{connection_id}/companies` | [`g8.api.integrations.listCrmCompanies`](integrations.md#op-listcrmcompanies) | read |
|
|
1476
|
+
| POST | `/api/v1/integrations/crm/connections/{connection_id}/companies` | [`g8.api.integrations.createCrmCompany`](integrations.md#op-createcrmcompany) | external |
|
|
1477
|
+
| GET | `/api/v1/integrations/crm/connections/{connection_id}/companies/{company_id}` | [`g8.api.integrations.getCrmCompany`](integrations.md#op-getcrmcompany) | read |
|
|
1478
|
+
| PUT | `/api/v1/integrations/crm/connections/{connection_id}/companies/{company_id}` | [`g8.api.integrations.updateCrmCompany`](integrations.md#op-updatecrmcompany) | external |
|
|
1479
|
+
| GET | `/api/v1/integrations/crm/connections/{connection_id}/contacts` | [`g8.api.integrations.listCrmContacts`](integrations.md#op-listcrmcontacts) | read |
|
|
1480
|
+
| POST | `/api/v1/integrations/crm/connections/{connection_id}/contacts` | [`g8.api.integrations.createCrmContact`](integrations.md#op-createcrmcontact) | external |
|
|
1481
|
+
| DELETE | `/api/v1/integrations/crm/connections/{connection_id}/contacts/{contact_id}` | [`g8.api.integrations.deleteCrmContact`](integrations.md#op-deletecrmcontact) | destructive |
|
|
1482
|
+
| GET | `/api/v1/integrations/crm/connections/{connection_id}/contacts/{contact_id}` | [`g8.api.integrations.getCrmContact`](integrations.md#op-getcrmcontact) | read |
|
|
1483
|
+
| PUT | `/api/v1/integrations/crm/connections/{connection_id}/contacts/{contact_id}` | [`g8.api.integrations.updateCrmContact`](integrations.md#op-updatecrmcontact) | external |
|
|
1484
|
+
| GET | `/api/v1/integrations/crm/connections/{connection_id}/contacts/{contact_id}/activities` | [`g8.api.integrations.listCrmContactActivities`](integrations.md#op-listcrmcontactactivities) | read |
|
|
1485
|
+
| GET | `/api/v1/integrations/crm/connections/{connection_id}/deals` | [`g8.api.integrations.listCrmDeals`](integrations.md#op-listcrmdeals) | read |
|
|
1486
|
+
| POST | `/api/v1/integrations/crm/connections/{connection_id}/deals` | [`g8.api.integrations.createCrmDeal`](integrations.md#op-createcrmdeal) | external |
|
|
1487
|
+
| GET | `/api/v1/integrations/crm/connections/{connection_id}/deals/{deal_id}` | [`g8.api.integrations.getCrmDeal`](integrations.md#op-getcrmdeal) | read |
|
|
1488
|
+
| PUT | `/api/v1/integrations/crm/connections/{connection_id}/deals/{deal_id}` | [`g8.api.integrations.updateCrmDeal`](integrations.md#op-updatecrmdeal) | external |
|
|
1489
|
+
| GET | `/api/v1/integrations/crm/connections/{connection_id}/leads` | [`g8.api.integrations.listCrmLeads`](integrations.md#op-listcrmleads) | read |
|
|
1490
|
+
| POST | `/api/v1/integrations/crm/connections/{connection_id}/leads` | [`g8.api.integrations.createCrmLead`](integrations.md#op-createcrmlead) | external |
|
|
1491
|
+
| GET | `/api/v1/integrations/crm/connections/{connection_id}/leads/{lead_id}` | [`g8.api.integrations.getCrmLead`](integrations.md#op-getcrmlead) | read |
|
|
1492
|
+
| PUT | `/api/v1/integrations/crm/connections/{connection_id}/leads/{lead_id}` | [`g8.api.integrations.updateCrmLead`](integrations.md#op-updatecrmlead) | external |
|
|
1493
|
+
| GET | `/api/v1/integrations/crm/connections/{connection_id}/metadata` | [`g8.api.integrations.getCrmConnectionMetadata`](integrations.md#op-getcrmconnectionmetadata) | read |
|
|
1494
|
+
| GET | `/api/v1/integrations/crm/connections/{connection_id}/status` | [`g8.api.integrations.getCrmConnectionStatus`](integrations.md#op-getcrmconnectionstatus) | read |
|
|
1495
|
+
| GET | `/api/v1/integrations/crm/contact-activities` | [`g8.api.integrations.listContactActivitiesByGraph8Id`](integrations.md#op-listcontactactivitiesbygraph8id) | read |
|
|
1496
|
+
| GET | `/api/v1/integrations/crm/fields` | [`g8.api.integrations.discoverCrmFields`](integrations.md#op-discovercrmfields) | read |
|
|
1497
|
+
| GET | `/api/v1/integrations/crm/fields/mappable` | [`g8.api.integrations.listMappableGraph8Fields`](integrations.md#op-listmappablegraph8fields) | read |
|
|
1498
|
+
| GET | `/api/v1/integrations/crm/lists` | [`g8.api.integrations.listCrmLists`](integrations.md#op-listcrmlists) | read |
|
|
1499
|
+
| POST | `/api/v1/integrations/crm/lists` | [`g8.api.integrations.getOrCreateCrmList`](integrations.md#op-getorcreatecrmlist) | external |
|
|
1500
|
+
| POST | `/api/v1/integrations/crm/lists/memberships` | [`g8.api.integrations.modifyCrmListMemberships`](integrations.md#op-modifycrmlistmemberships) | external |
|
|
1501
|
+
| GET | `/api/v1/integrations/crm/meetings` | [`g8.api.integrations.listCrmMeetings`](integrations.md#op-listcrmmeetings) | read |
|
|
1502
|
+
| POST | `/api/v1/integrations/crm/meetings` | [`g8.api.integrations.createCrmMeeting`](integrations.md#op-createcrmmeeting) | external |
|
|
1503
|
+
| PATCH | `/api/v1/integrations/crm/meetings/{event_id}` | [`g8.api.integrations.updateCrmMeeting`](integrations.md#op-updatecrmmeeting) | external |
|
|
1504
|
+
| GET | `/api/v1/integrations/crm/users` | [`g8.api.integrations.listCrmUsers`](integrations.md#op-listcrmusers) | read |
|
|
1505
|
+
| GET | `/api/v1/integrations/crm/users/by-email` | [`g8.api.integrations.findCrmUserByEmail`](integrations.md#op-findcrmuserbyemail) | read |
|
|
1506
|
+
| GET | `/api/v1/integrations/google-workspace` | [`g8.api.integrationStatus.getGoogleWorkspaceStatus`](integrationStatus.md#op-getgoogleworkspacestatus) | read |
|
|
1507
|
+
| GET | `/api/v1/integrations/google-workspace/folders` | [`g8.api.integrationStatus.listGoogleDriveFolders`](integrationStatus.md#op-listgoogledrivefolders) | read |
|
|
1508
|
+
| GET | `/api/v1/integrations/google-workspace/folders/{folder_id}/files` | [`g8.api.integrationStatus.listGoogleDriveFolderFiles`](integrationStatus.md#op-listgoogledrivefolderfiles) | read |
|
|
1509
|
+
| POST | `/api/v1/integrations/google-workspace/test` | [`g8.api.integrationStatus.testGoogleWorkspaceConnection`](integrationStatus.md#op-testgoogleworkspaceconnection) | read |
|
|
1510
|
+
| GET | `/api/v1/integrations/linkedin-outreach/accounts` | [`g8.api.linkedInOutreach.listOutreachSenderAccounts`](linkedInOutreach.md#op-listoutreachsenderaccounts) | read |
|
|
1511
|
+
| GET | `/api/v1/integrations/linkedin-outreach/campaigns` | [`g8.api.linkedInOutreach.listOutreachCampaigns`](linkedInOutreach.md#op-listoutreachcampaigns) | read |
|
|
1512
|
+
| POST | `/api/v1/integrations/linkedin-outreach/campaigns/{campaign_id}/leads/search` | [`g8.api.linkedInOutreach.searchOutreachCampaignLeads`](linkedInOutreach.md#op-searchoutreachcampaignleads) | read |
|
|
1513
|
+
| POST | `/api/v1/integrations/linkedin-outreach/campaigns/{campaign_id}/pause` | [`g8.api.linkedInOutreach.pauseOutreachCampaign`](linkedInOutreach.md#op-pauseoutreachcampaign) | external |
|
|
1514
|
+
| GET | `/api/v1/integrations/linkedin-outreach/campaigns/{campaign_id}/progress` | [`g8.api.linkedInOutreach.getOutreachCampaignProgress`](linkedInOutreach.md#op-getoutreachcampaignprogress) | read |
|
|
1515
|
+
| POST | `/api/v1/integrations/linkedin-outreach/campaigns/{campaign_id}/resume` | [`g8.api.linkedInOutreach.resumeOutreachCampaign`](linkedInOutreach.md#op-resumeoutreachcampaign) | external |
|
|
1516
|
+
| GET | `/api/v1/integrations/linkedin-outreach/campaigns/{campaign_id}/stats` | [`g8.api.linkedInOutreach.getOutreachCampaignStats`](linkedInOutreach.md#op-getoutreachcampaignstats) | read |
|
|
1517
|
+
| GET | `/api/v1/integrations/linkedin-outreach/connection` | [`g8.api.linkedInOutreach.getOutreachConnection`](linkedInOutreach.md#op-getoutreachconnection) | read |
|
|
1518
|
+
| POST | `/api/v1/integrations/linkedin-outreach/connection/reconnect` | [`g8.api.linkedInOutreach.reconnectOutreach`](linkedInOutreach.md#op-reconnectoutreach) | external |
|
|
1519
|
+
| GET | `/api/v1/integrations/linkedin-outreach/lists` | [`g8.api.linkedInOutreach.listOutreachLists`](linkedInOutreach.md#op-listoutreachlists) | read |
|
|
1520
|
+
| POST | `/api/v1/integrations/linkedin-outreach/lists` | [`g8.api.linkedInOutreach.createOutreachList`](linkedInOutreach.md#op-createoutreachlist) | external |
|
|
1521
|
+
| POST | `/api/v1/integrations/linkedin-outreach/lists/{list_id}/leads` | [`g8.api.linkedInOutreach.addOutreachListLeads`](linkedInOutreach.md#op-addoutreachlistleads) | external |
|
|
1522
|
+
| GET | `/api/v1/integrations/linkedin-outreach/sequences/{sequence_id}/mapping` | [`g8.api.linkedInOutreach.getOutreachSequenceMapping`](linkedInOutreach.md#op-getoutreachsequencemapping) | read |
|
|
1523
|
+
| GET | `/api/v1/integrations/linkedin-outreach/sequences/{sequence_id}/progress` | [`g8.api.linkedInOutreach.getOutreachSequenceProgress`](linkedInOutreach.md#op-getoutreachsequenceprogress) | read |
|
|
1524
|
+
| GET | `/api/v1/integrations/linkedin-outreach/sequences/{sequence_id}/step-campaigns` | [`g8.api.linkedInOutreach.listOutreachSequenceStepCampaigns`](linkedInOutreach.md#op-listoutreachsequencestepcampaigns) | read |
|
|
1525
|
+
| GET | `/api/v1/integrations/linkedin-outreach/templates` | [`g8.api.linkedInOutreach.listOutreachTemplates`](linkedInOutreach.md#op-listoutreachtemplates) | read |
|
|
1526
|
+
| GET | `/api/v1/integrations/linkedin-outreach/workspaces` | [`g8.api.linkedInOutreach.listOutreachWorkspaces`](linkedInOutreach.md#op-listoutreachworkspaces) | read |
|
|
1527
|
+
| GET | `/api/v1/integrations/linkedin-outreach/workspaces/active` | [`g8.api.linkedInOutreach.getActiveOutreachWorkspace`](linkedInOutreach.md#op-getactiveoutreachworkspace) | read |
|
|
1528
|
+
| PUT | `/api/v1/integrations/linkedin-outreach/workspaces/active` | [`g8.api.linkedInOutreach.selectActiveOutreachWorkspace`](linkedInOutreach.md#op-selectactiveoutreachworkspace) | external |
|
|
1529
|
+
| POST | `/api/v1/integrations/linkedin-outreach/workspaces/sync` | [`g8.api.linkedInOutreach.syncOutreachWorkspace`](linkedInOutreach.md#op-syncoutreachworkspace) | external |
|
|
1530
|
+
| POST | `/api/v1/integrations/migrations/delta-sync` | [`g8.api.integrations.startDeltaSync`](integrations.md#op-startdeltasync) | external |
|
|
1531
|
+
| POST | `/api/v1/integrations/migrations/discovery` | [`g8.api.integrations.startMigrationDiscovery`](integrations.md#op-startmigrationdiscovery) | external |
|
|
1532
|
+
| GET | `/api/v1/integrations/migrations/{migration_id}` | [`g8.api.integrations.getMigrationStatus`](integrations.md#op-getmigrationstatus) | read |
|
|
1533
|
+
| POST | `/api/v1/integrations/migrations/{migration_id}/cancel` | [`g8.api.integrations.cancelMigration`](integrations.md#op-cancelmigration) | destructive |
|
|
1534
|
+
| POST | `/api/v1/integrations/migrations/{migration_id}/confirm` | [`g8.api.integrations.confirmMigration`](integrations.md#op-confirmmigration) | external |
|
|
1535
|
+
| GET | `/api/v1/integrations/roam/status` | [`g8.api.integrationStatus.getRoamStatus`](integrationStatus.md#op-getroamstatus) | read |
|
|
1536
|
+
| GET | `/api/v1/integrations/slack/status` | [`g8.api.integrationStatus.getSlackStatus`](integrationStatus.md#op-getslackstatus) | read |
|
|
1537
|
+
| DELETE | `/api/v1/integrations/sugarcrm` | [`g8.api.integrations.disconnectSugarcrm`](integrations.md#op-disconnectsugarcrm) | destructive |
|
|
1538
|
+
| POST | `/api/v1/integrations/sugarcrm/connect` | [`g8.api.integrations.connectSugarcrm`](integrations.md#op-connectsugarcrm) | external |
|
|
1539
|
+
| POST | `/api/v1/integrations/sugarcrm/reconnect` | [`g8.api.integrations.reconnectSugarcrm`](integrations.md#op-reconnectsugarcrm) | external |
|
|
1540
|
+
| POST | `/api/v1/integrations/sugarcrm/validate` | [`g8.api.integrations.validateSugarcrm`](integrations.md#op-validatesugarcrm) | read |
|
|
1541
|
+
| DELETE | `/api/v1/intelligence` | [`g8.api.companyIntelligence.resetIntelligence`](companyIntelligence.md#op-resetintelligence) | destructive |
|
|
1542
|
+
| GET | `/api/v1/intelligence-data` | [`g8.api.gtmContext.listIntelligenceData`](gtmContext.md#op-listintelligencedata) or `g8.studio.intelligenceData()` | read |
|
|
1543
|
+
| GET | `/api/v1/intelligence/all/{website_url}` | [`g8.api.companyIntelligence.getAllIntelligenceData`](companyIntelligence.md#op-getallintelligencedata) | read |
|
|
1544
|
+
| POST | `/api/v1/intelligence/analyze` | [`g8.api.companyIntelligence.analyzeWebsite`](companyIntelligence.md#op-analyzewebsite) | billable |
|
|
1545
|
+
| GET | `/api/v1/intelligence/data/{data_type}` | [`g8.api.companyIntelligence.getIntelligenceData`](companyIntelligence.md#op-getintelligencedata) | read |
|
|
1546
|
+
| GET | `/api/v1/intelligence/documents` | [`g8.api.companyIntelligence.listIntelligenceDocuments`](companyIntelligence.md#op-listintelligencedocuments) | read |
|
|
1547
|
+
| GET | `/api/v1/intelligence/latest-task` | [`g8.api.companyIntelligence.getLatestIntelligenceTask`](companyIntelligence.md#op-getlatestintelligencetask) | read |
|
|
1548
|
+
| GET | `/api/v1/intelligence/org-domain` | [`g8.api.companyIntelligence.getIntelligenceOrgDomain`](companyIntelligence.md#op-getintelligenceorgdomain) | read |
|
|
1549
|
+
| GET | `/api/v1/intelligence/primary-website` | [`g8.api.companyIntelligence.getIntelligencePrimaryWebsite`](companyIntelligence.md#op-getintelligenceprimarywebsite) | read |
|
|
1550
|
+
| POST | `/api/v1/intelligence/retry` | [`g8.api.companyIntelligence.retryIntelligenceSource`](companyIntelligence.md#op-retryintelligencesource) | billable |
|
|
1551
|
+
| GET | `/api/v1/intelligence/status/{task_id}` | [`g8.api.companyIntelligence.getIntelligenceStatus`](companyIntelligence.md#op-getintelligencestatus) | read |
|
|
1552
|
+
| GET | `/api/v1/intent/abm/companies` | [`g8.api.signals.listAbmCompanies`](signals.md#op-listabmcompanies) | read |
|
|
1553
|
+
| GET | `/api/v1/intent/abm/companies/{company_id}/personas` | [`g8.api.signals.getAbmCompanyPersonas`](signals.md#op-getabmcompanypersonas) | read |
|
|
1554
|
+
| POST | `/api/v1/intent/abm/rollup` | [`g8.api.signals.rollupAbmCompanies`](signals.md#op-rollupabmcompanies) | read |
|
|
1555
|
+
| POST | `/api/v1/intent/contacts/metadata` | [`g8.api.signals.saveIntentToContactMetadata`](signals.md#op-saveintenttocontactmetadata) | billable |
|
|
1556
|
+
| DELETE | `/api/v1/intent/keyword-urls/{url_id}` | [`g8.api.signals.deleteKeywordUrl`](signals.md#op-deletekeywordurl) | destructive |
|
|
1557
|
+
| POST | `/api/v1/intent/keywords/add` | [`g8.api.intent.keywordsAdd`](intent.md#op-keywordsadd) | billable |
|
|
1558
|
+
| POST | `/api/v1/intent/keywords/auto-seed-proposals` | [`g8.api.signals.proposeHiringKeywords`](signals.md#op-proposehiringkeywords) | billable |
|
|
1559
|
+
| POST | `/api/v1/intent/keywords/create-from-domain` | [`g8.api.intent.keywordsCreateFromDomain`](intent.md#op-keywordscreatefromdomain) or `g8.intent.createFromDomain()` | billable |
|
|
1560
|
+
| POST | `/api/v1/intent/keywords/create-from-search` | [`g8.api.intent.keywordsCreateFromSearch`](intent.md#op-keywordscreatefromsearch) | billable |
|
|
1561
|
+
| POST | `/api/v1/intent/keywords/list` | [`g8.api.intent.keywordsList`](intent.md#op-keywordslist) or `g8.intent.listKeywords()` | billable |
|
|
1562
|
+
| POST | `/api/v1/intent/keywords/preview` | [`g8.api.signals.previewKeywordUrls`](signals.md#op-previewkeywordurls) | read |
|
|
1563
|
+
| DELETE | `/api/v1/intent/keywords/{keyword_id}` | [`g8.api.intent.keywordsDelete`](intent.md#op-keywordsdelete) or `g8.intent.deleteKeyword()` | destructive |
|
|
1564
|
+
| PATCH | `/api/v1/intent/keywords/{keyword_id}` | [`g8.api.signals.updateHiringKeyword`](signals.md#op-updatehiringkeyword) | billable |
|
|
1565
|
+
| POST | `/api/v1/intent/keywords/{keyword_id}/companies` | [`g8.api.intent.keywordCompanies`](intent.md#op-keywordcompanies) or `g8.intent.keywordCompanies()` | billable |
|
|
1566
|
+
| POST | `/api/v1/intent/keywords/{keyword_id}/contacts` | [`g8.api.intent.keywordContacts`](intent.md#op-keywordcontacts) or `g8.intent.keywordContacts()` | billable |
|
|
1567
|
+
| POST | `/api/v1/intent/keywords/{keyword_id}/filters` | [`g8.api.intent.keywordUpdateFilters`](intent.md#op-keywordupdatefilters) | billable |
|
|
1568
|
+
| GET | `/api/v1/intent/keywords/{keyword_id}/job-resolution` | [`g8.api.signals.getJobResolutionStatus`](signals.md#op-getjobresolutionstatus) | read |
|
|
1569
|
+
| POST | `/api/v1/intent/keywords/{keyword_id}/job-resolution` | [`g8.api.signals.resolveJobsForKeyword`](signals.md#op-resolvejobsforkeyword) | billable |
|
|
1570
|
+
| POST | `/api/v1/intent/keywords/{keyword_id}/sync` | [`g8.api.signals.triggerKeywordSync`](signals.md#op-triggerkeywordsync) | billable |
|
|
1571
|
+
| GET | `/api/v1/intent/keywords/{keyword_id}/sync-config` | [`g8.api.signals.getKeywordSyncConfig`](signals.md#op-getkeywordsyncconfig) | read |
|
|
1572
|
+
| PATCH | `/api/v1/intent/keywords/{keyword_id}/sync-config` | [`g8.api.signals.saveKeywordSyncConfig`](signals.md#op-savekeywordsyncconfig) | billable |
|
|
1573
|
+
| POST | `/api/v1/intent/keywords/{keyword_id}/urls` | [`g8.api.intent.keywordUrls`](intent.md#op-keywordurls) or `g8.intent.keywordUrls()` | billable |
|
|
1574
|
+
| POST | `/api/v1/intent/pages-by-domain` | [`g8.api.intent.pagesByDomain`](intent.md#op-pagesbydomain) or `g8.intent.pagesByDomain()` | billable |
|
|
1575
|
+
| POST | `/api/v1/intent/pages/contacts` | [`g8.api.intent.pagesContacts`](intent.md#op-pagescontacts) or `g8.intent.pageContacts()` | billable |
|
|
1576
|
+
| POST | `/api/v1/intent/pages/search` | [`g8.api.intent.pagesSearch`](intent.md#op-pagessearch) or `g8.intent.searchPages()` | billable |
|
|
1577
|
+
| POST | `/api/v1/intent/pages/visitor-counts` | [`g8.api.intent.pagesVisitorCounts`](intent.md#op-pagesvisitorcounts) or `g8.intent.pageVisitorCounts()` | billable |
|
|
1578
|
+
| POST | `/api/v1/intent/pages/visitors` | [`g8.api.intent.pagesVisitors`](intent.md#op-pagesvisitors) or `g8.intent.pageVisitors()` | billable |
|
|
1579
|
+
| GET | `/api/v1/intent/stats` | [`g8.api.intent.intentStats`](intent.md#op-intentstats) or `g8.intent.stats()` | read |
|
|
1580
|
+
| POST | `/api/v1/intent/url-companies` | [`g8.api.intent.urlCompanies`](intent.md#op-urlcompanies) or `g8.intent.urlCompanies()` | read |
|
|
1581
|
+
| GET | `/api/v1/kb` | [`g8.api.gtmKnowledgeBase.listKbDocuments`](gtmKnowledgeBase.md#op-listkbdocuments) | read |
|
|
1582
|
+
| POST | `/api/v1/kb/search` | [`g8.api.gtmKnowledgeBase.searchKb`](gtmKnowledgeBase.md#op-searchkb) | write |
|
|
1583
|
+
| GET | `/api/v1/knowledge` | [`g8.api.knowledge.listKnowledge`](knowledge.md#op-listknowledge) | read |
|
|
1584
|
+
| GET | `/api/v1/knowledge-governance` | [`g8.api.knowledge.listKnowledgeGovernanceQueue`](knowledge.md#op-listknowledgegovernancequeue) | read |
|
|
1585
|
+
| GET | `/api/v1/knowledge-ontology` | [`g8.api.knowledge.getOntologyOverview`](knowledge.md#op-getontologyoverview) | read |
|
|
1586
|
+
| GET | `/api/v1/knowledge-ontology/deviations` | [`g8.api.knowledge.getOntologyDeviations`](knowledge.md#op-getontologydeviations) | read |
|
|
1587
|
+
| GET | `/api/v1/knowledge-ontology/readiness` | [`g8.api.knowledge.getOntologyReadiness`](knowledge.md#op-getontologyreadiness) | read |
|
|
1588
|
+
| GET | `/api/v1/knowledge-ontology/standard` | [`g8.api.knowledge.getStandardOntology`](knowledge.md#op-getstandardontology) | read |
|
|
1589
|
+
| PUT | `/api/v1/knowledge-ontology/{concept_id}` | [`g8.api.knowledge.upsertOntologyConcept`](knowledge.md#op-upsertontologyconcept) | write |
|
|
1590
|
+
| POST | `/api/v1/knowledge/authored` | [`g8.api.knowledge.createAuthoredKnowledge`](knowledge.md#op-createauthoredknowledge) | write |
|
|
1591
|
+
| PATCH | `/api/v1/knowledge/authored/{concept_id}` | [`g8.api.knowledge.updateAuthoredKnowledgeDraft`](knowledge.md#op-updateauthoredknowledgedraft) | write |
|
|
1592
|
+
| POST | `/api/v1/knowledge/authored/{concept_id}/amendments` | [`g8.api.knowledge.createAuthoredKnowledgeAmendment`](knowledge.md#op-createauthoredknowledgeamendment) | write |
|
|
1593
|
+
| POST | `/api/v1/knowledge/authored/{concept_id}/deprecate` | [`g8.api.knowledge.deprecateAuthoredKnowledge`](knowledge.md#op-deprecateauthoredknowledge) | write |
|
|
1594
|
+
| POST | `/api/v1/knowledge/authored/{concept_id}/verify` | [`g8.api.knowledge.verifyAuthoredKnowledge`](knowledge.md#op-verifyauthoredknowledge) | write |
|
|
1595
|
+
| POST | `/api/v1/knowledge/context` | [`g8.api.knowledge.assembleKnowledgeContext`](knowledge.md#op-assembleknowledgecontext) | read |
|
|
1596
|
+
| GET | `/api/v1/knowledge/export` | [`g8.api.knowledge.exportKnowledge`](knowledge.md#op-exportknowledge) | read |
|
|
1597
|
+
| GET | `/api/v1/knowledge/search` | [`g8.api.knowledge.searchKnowledge`](knowledge.md#op-searchknowledge) | read |
|
|
1598
|
+
| GET | `/api/v1/knowledge/status` | [`g8.api.knowledge.getKnowledgeStatus`](knowledge.md#op-getknowledgestatus) | read |
|
|
1599
|
+
| GET | `/api/v1/knowledge/tree` | [`g8.api.knowledge.browseKnowledgeTree`](knowledge.md#op-browseknowledgetree) | read |
|
|
1600
|
+
| GET | `/api/v1/knowledge/{concept_id}` | [`g8.api.knowledge.getKnowledge`](knowledge.md#op-getknowledge) | read |
|
|
1601
|
+
| GET | `/api/v1/knowledge/{concept_id}/history` | [`g8.api.knowledge.getKnowledgeHistory`](knowledge.md#op-getknowledgehistory) | read |
|
|
1602
|
+
| GET | `/api/v1/knowledge/{concept_id}/related` | [`g8.api.knowledge.relatedKnowledge`](knowledge.md#op-relatedknowledge) | read |
|
|
1603
|
+
| GET | `/api/v1/knowledge/{concept_id}/sources` | [`g8.api.knowledge.knowledgeSources`](knowledge.md#op-knowledgesources) | read |
|
|
1604
|
+
| GET | `/api/v1/landing-page-consent/default` | [`g8.api.landingPages.getLandingPageConsentDefault`](landingPages.md#op-getlandingpageconsentdefault) | read |
|
|
1605
|
+
| PUT | `/api/v1/landing-page-consent/default` | [`g8.api.landingPages.setLandingPageConsentDefault`](landingPages.md#op-setlandingpageconsentdefault) | write |
|
|
1606
|
+
| GET | `/api/v1/landing-page-consent/pages` | [`g8.api.landingPages.listLandingPageConsentStatus`](landingPages.md#op-listlandingpageconsentstatus) | read |
|
|
1607
|
+
| GET | `/api/v1/landing-pages` | [`g8.api.landingPages.listLandingPages`](landingPages.md#op-listlandingpages) | read |
|
|
1608
|
+
| POST | `/api/v1/landing-pages` | [`g8.api.landingPages.createLandingPage`](landingPages.md#op-createlandingpage) | billable |
|
|
1609
|
+
| GET | `/api/v1/landing-pages/agent-sessions/{session_id}` | [`g8.api.landingPages.getLandingPageSource`](landingPages.md#op-getlandingpagesource) | read |
|
|
1610
|
+
| POST | `/api/v1/landing-pages/agent-sessions/{session_id}/patch` | [`g8.api.landingPages.patchLandingPage`](landingPages.md#op-patchlandingpage) | write |
|
|
1611
|
+
| POST | `/api/v1/landing-pages/clone-homepage` | [`g8.api.landingPages.cloneHomepageToLandingPage`](landingPages.md#op-clonehomepagetolandingpage) | billable |
|
|
1612
|
+
| POST | `/api/v1/landing-pages/clone-html` | [`g8.api.landingPages.cloneHtmlToLandingPage`](landingPages.md#op-clonehtmltolandingpage) | billable |
|
|
1613
|
+
| POST | `/api/v1/landing-pages/clone-url` | [`g8.api.landingPages.cloneUrlToLandingPage`](landingPages.md#op-cloneurltolandingpage) | billable |
|
|
1614
|
+
| GET | `/api/v1/landing-pages/components` | [`g8.api.landingPages.listLandingPageComponents`](landingPages.md#op-listlandingpagecomponents) | read |
|
|
1615
|
+
| POST | `/api/v1/landing-pages/components/extract` | [`g8.api.landingPages.extractLandingPageComponents`](landingPages.md#op-extractlandingpagecomponents) | billable |
|
|
1616
|
+
| GET | `/api/v1/landing-pages/design-system` | [`g8.api.landingPages.getLandingPageDesignSystem`](landingPages.md#op-getlandingpagedesignsystem) | read |
|
|
1617
|
+
| GET | `/api/v1/landing-pages/domains` | [`g8.api.landingPages.listLandingPageDomains`](landingPages.md#op-listlandingpagedomains) | read |
|
|
1618
|
+
| POST | `/api/v1/landing-pages/ensure-base-template` | [`g8.api.landingPages.ensureLandingPageBaseTemplate`](landingPages.md#op-ensurelandingpagebasetemplate) | billable |
|
|
1619
|
+
| GET | `/api/v1/landing-pages/reporting/companies` | [`g8.api.landingPages.listLandingPageReportingCompanies`](landingPages.md#op-listlandingpagereportingcompanies) | read |
|
|
1620
|
+
| GET | `/api/v1/landing-pages/reporting/overview` | [`g8.api.landingPages.getLandingPageReportingOverview`](landingPages.md#op-getlandingpagereportingoverview) | read |
|
|
1621
|
+
| GET | `/api/v1/landing-pages/reporting/people` | [`g8.api.landingPages.listLandingPageReportingPeople`](landingPages.md#op-listlandingpagereportingpeople) | read |
|
|
1622
|
+
| DELETE | `/api/v1/landing-pages/{landing_page_id}` | [`g8.api.landingPages.deleteLandingPage`](landingPages.md#op-deletelandingpage) | destructive |
|
|
1623
|
+
| GET | `/api/v1/landing-pages/{landing_page_id}` | [`g8.api.landingPages.getLandingPage`](landingPages.md#op-getlandingpage) | read |
|
|
1624
|
+
| PATCH | `/api/v1/landing-pages/{landing_page_id}` | [`g8.api.landingPages.updateLandingPage`](landingPages.md#op-updatelandingpage) | write |
|
|
1625
|
+
| POST | `/api/v1/landing-pages/{landing_page_id}/ai-review` | [`g8.api.landingPages.reviewLandingPage`](landingPages.md#op-reviewlandingpage) | billable |
|
|
1626
|
+
| POST | `/api/v1/landing-pages/{landing_page_id}/ai-review/apply` | [`g8.api.landingPages.applyLandingPageReviewFindings`](landingPages.md#op-applylandingpagereviewfindings) | write |
|
|
1627
|
+
| POST | `/api/v1/landing-pages/{landing_page_id}/ai-review/fix-with-ai` | [`g8.api.landingPages.fixLandingPageFindingWithAi`](landingPages.md#op-fixlandingpagefindingwithai) | billable |
|
|
1628
|
+
| GET | `/api/v1/landing-pages/{landing_page_id}/anchors` | [`g8.api.landingPages.listLandingPageAnchors`](landingPages.md#op-listlandingpageanchors) | read |
|
|
1629
|
+
| PATCH | `/api/v1/landing-pages/{landing_page_id}/approve-template` | [`g8.api.landingPages.approveLandingPageTemplate`](landingPages.md#op-approvelandingpagetemplate) | write |
|
|
1630
|
+
| DELETE | `/api/v1/landing-pages/{landing_page_id}/bindings` | [`g8.api.landingPages.removeLandingPageBinding`](landingPages.md#op-removelandingpagebinding) | destructive |
|
|
1631
|
+
| GET | `/api/v1/landing-pages/{landing_page_id}/bindings` | [`g8.api.landingPages.listLandingPageBindings`](landingPages.md#op-listlandingpagebindings) | read |
|
|
1632
|
+
| GET | `/api/v1/landing-pages/{landing_page_id}/conversation` | [`g8.api.landingPages.getLandingPageConversation`](landingPages.md#op-getlandingpageconversation) | read |
|
|
1633
|
+
| POST | `/api/v1/landing-pages/{landing_page_id}/convert-to-freeform` | [`g8.api.landingPages.convertLandingPageToFreeform`](landingPages.md#op-convertlandingpagetofreeform) | write |
|
|
1634
|
+
| POST | `/api/v1/landing-pages/{landing_page_id}/demote-to-template` | [`g8.api.landingPages.demoteLandingPageToTemplate`](landingPages.md#op-demotelandingpagetotemplate) | write |
|
|
1635
|
+
| POST | `/api/v1/landing-pages/{landing_page_id}/duplicate` | [`g8.api.landingPages.duplicateLandingPageTemplate`](landingPages.md#op-duplicatelandingpagetemplate) | write |
|
|
1636
|
+
| POST | `/api/v1/landing-pages/{landing_page_id}/edit` | [`g8.api.landingPages.editLandingPageWithChat`](landingPages.md#op-editlandingpagewithchat) | billable |
|
|
1637
|
+
| POST | `/api/v1/landing-pages/{landing_page_id}/edit-element` | [`g8.api.landingPages.editLandingPageElement`](landingPages.md#op-editlandingpageelement) | billable |
|
|
1638
|
+
| POST | `/api/v1/landing-pages/{landing_page_id}/edit-page` | [`g8.api.landingPages.editLandingPageWhole`](landingPages.md#op-editlandingpagewhole) | billable |
|
|
1639
|
+
| GET | `/api/v1/landing-pages/{landing_page_id}/export` | [`g8.api.landingPages.exportLandingPage`](landingPages.md#op-exportlandingpage) | read |
|
|
1640
|
+
| POST | `/api/v1/landing-pages/{landing_page_id}/generate-seo-metadata` | [`g8.api.landingPages.generateLandingPageSeoMetadata`](landingPages.md#op-generatelandingpageseometadata) | billable |
|
|
1641
|
+
| POST | `/api/v1/landing-pages/{landing_page_id}/import-html` | [`g8.api.landingPages.importLandingPageHtml`](landingPages.md#op-importlandingpagehtml) | write |
|
|
1642
|
+
| GET | `/api/v1/landing-pages/{landing_page_id}/manifest` | [`g8.api.landingPages.getLandingPageManifest`](landingPages.md#op-getlandingpagemanifest) | read |
|
|
1643
|
+
| GET | `/api/v1/landing-pages/{landing_page_id}/preview` | [`g8.api.landingPages.createLandingPagePreviewLink`](landingPages.md#op-createlandingpagepreviewlink) | read |
|
|
1644
|
+
| POST | `/api/v1/landing-pages/{landing_page_id}/promote-to-page` | [`g8.api.landingPages.promoteLandingPageTemplate`](landingPages.md#op-promotelandingpagetemplate) | write |
|
|
1645
|
+
| POST | `/api/v1/landing-pages/{landing_page_id}/publish` | [`g8.api.landingPages.publishLandingPage`](landingPages.md#op-publishlandingpage) | external |
|
|
1646
|
+
| POST | `/api/v1/landing-pages/{landing_page_id}/replace-html` | [`g8.api.landingPages.replaceLandingPageHtml`](landingPages.md#op-replacelandingpagehtml) | write |
|
|
1647
|
+
| POST | `/api/v1/landing-pages/{landing_page_id}/rewrite-text` | [`g8.api.landingPages.rewriteLandingPageText`](landingPages.md#op-rewritelandingpagetext) | billable |
|
|
1648
|
+
| POST | `/api/v1/landing-pages/{landing_page_id}/save-as-page` | [`g8.api.landingPages.saveLandingPageTemplateAsPage`](landingPages.md#op-savelandingpagetemplateaspage) | write |
|
|
1649
|
+
| PATCH | `/api/v1/landing-pages/{landing_page_id}/sections/{section_idx}` | [`g8.api.landingPages.updateLandingPageSection`](landingPages.md#op-updatelandingpagesection) | write |
|
|
1650
|
+
| POST | `/api/v1/landing-pages/{landing_page_id}/set-media-edit` | [`g8.api.landingPages.setLandingPageMedia`](landingPages.md#op-setlandingpagemedia) | write |
|
|
1651
|
+
| POST | `/api/v1/landing-pages/{landing_page_id}/set-text` | [`g8.api.landingPages.setLandingPageText`](landingPages.md#op-setlandingpagetext) | write |
|
|
1652
|
+
| GET | `/api/v1/landing-pages/{landing_page_id}/status` | [`g8.api.landingPages.getLandingPageStatus`](landingPages.md#op-getlandingpagestatus) | read |
|
|
1653
|
+
| GET | `/api/v1/landing-pages/{landing_page_id}/tracking` | [`g8.api.landingPages.getLandingPageTracking`](landingPages.md#op-getlandingpagetracking) | read |
|
|
1654
|
+
| PATCH | `/api/v1/landing-pages/{landing_page_id}/tracking` | [`g8.api.landingPages.updateLandingPageTracking`](landingPages.md#op-updatelandingpagetracking) | write |
|
|
1655
|
+
| DELETE | `/api/v1/landing-pages/{landing_page_id}/tracking/consent` | [`g8.api.landingPages.clearLandingPageConsentOverride`](landingPages.md#op-clearlandingpageconsentoverride) | destructive |
|
|
1656
|
+
| POST | `/api/v1/landing-pages/{landing_page_id}/tracking/provision` | [`g8.api.landingPages.provisionLandingPageTracking`](landingPages.md#op-provisionlandingpagetracking) | write |
|
|
1657
|
+
| POST | `/api/v1/landing-pages/{landing_page_id}/unpublish` | [`g8.api.landingPages.unpublishLandingPage`](landingPages.md#op-unpublishlandingpage) | external |
|
|
1658
|
+
| POST | `/api/v1/landing-pages/{landing_page_id}/update-html` | [`g8.api.landingPages.updateLandingPageHtml`](landingPages.md#op-updatelandingpagehtml) | write |
|
|
1659
|
+
| POST | `/api/v1/landing-pages/{landing_page_id}/update-text` | [`g8.api.landingPages.updateLandingPageText`](landingPages.md#op-updatelandingpagetext) | write |
|
|
1660
|
+
| GET | `/api/v1/landing-pages/{landing_page_id}/versions` | [`g8.api.landingPages.listLandingPageVersions`](landingPages.md#op-listlandingpageversions) | read |
|
|
1661
|
+
| POST | `/api/v1/landing-pages/{landing_page_id}/versions/{version_num}/restore` | [`g8.api.landingPages.restoreLandingPageVersion`](landingPages.md#op-restorelandingpageversion) | write |
|
|
1662
|
+
| POST | `/api/v1/landing-pages/{page_id}/agent-sessions` | [`g8.api.landingPages.createLandingPageAgentSession`](landingPages.md#op-createlandingpageagentsession) | write |
|
|
1663
|
+
| POST | `/api/v1/leads/bulk-delete` | [`g8.api.leads.removeLeads`](leads.md#op-removeleads) | destructive |
|
|
1664
|
+
| POST | `/api/v1/leads/generate-content/batches` | [`g8.api.leads.startLeadContentBatch`](leads.md#op-startleadcontentbatch) | billable |
|
|
1665
|
+
| GET | `/api/v1/leads/generate-content/batches/{batch_id}` | [`g8.api.leads.getLeadContentBatch`](leads.md#op-getleadcontentbatch) | read |
|
|
1666
|
+
| POST | `/api/v1/leads/{lead_id}/generate-content` | [`g8.api.leads.generateLeadContent`](leads.md#op-generateleadcontent) | billable |
|
|
1667
|
+
| POST | `/api/v1/library/case-studies/backfill` | [`g8.api.library.backfillLibraryCaseStudies`](library.md#op-backfilllibrarycasestudies) | billable |
|
|
1668
|
+
| GET | `/api/v1/library/documents` | [`g8.api.documents.listLibraryDocuments`](documents.md#op-listlibrarydocuments) | read |
|
|
1669
|
+
| POST | `/api/v1/library/documents` | [`g8.api.documents.createLibraryDocument`](documents.md#op-createlibrarydocument) | write |
|
|
1670
|
+
| POST | `/api/v1/library/documents/reextract-all` | [`g8.api.documents.reextractAllLibraryDocuments`](documents.md#op-reextractalllibrarydocuments) | write |
|
|
1671
|
+
| POST | `/api/v1/library/documents/upload` | [`g8.api.documents.uploadLibraryDocument`](documents.md#op-uploadlibrarydocument) | write |
|
|
1672
|
+
| POST | `/api/v1/library/documents/upload-batch` | [`g8.api.documents.uploadLibraryDocuments`](documents.md#op-uploadlibrarydocuments) | write |
|
|
1673
|
+
| DELETE | `/api/v1/library/documents/{doc_id}` | [`g8.api.library.deleteLibraryDocument`](library.md#op-deletelibrarydocument) | destructive |
|
|
1674
|
+
| GET | `/api/v1/library/documents/{doc_id}` | [`g8.api.library.getLibraryDocument`](library.md#op-getlibrarydocument) | read |
|
|
1675
|
+
| PUT | `/api/v1/library/documents/{doc_id}` | [`g8.api.library.updateLibraryDocument`](library.md#op-updatelibrarydocument) | write |
|
|
1676
|
+
| GET | `/api/v1/library/documents/{doc_id}/download` | [`g8.api.library.downloadLibraryDocument`](library.md#op-downloadlibrarydocument) | read |
|
|
1677
|
+
| POST | `/api/v1/library/documents/{doc_id}/reextract` | [`g8.api.library.reextractLibraryDocument`](library.md#op-reextractlibrarydocument) | write |
|
|
1678
|
+
| POST | `/api/v1/library/documents/{doc_id}/refresh` | [`g8.api.library.refreshLibraryDocument`](library.md#op-refreshlibrarydocument) | write |
|
|
1679
|
+
| POST | `/api/v1/library/documents/{doc_id}/restore` | [`g8.api.library.restoreLibraryDocument`](library.md#op-restorelibrarydocument) | write |
|
|
1680
|
+
| DELETE | `/api/v1/library/documents/{document_id}` | [`g8.api.documents.deleteLibraryDocument`](documents.md#op-deletelibrarydocument) | destructive |
|
|
1681
|
+
| GET | `/api/v1/library/documents/{document_id}` | [`g8.api.documents.getLibraryDocument`](documents.md#op-getlibrarydocument) | read |
|
|
1682
|
+
| PUT | `/api/v1/library/documents/{document_id}` | [`g8.api.documents.updateLibraryDocument`](documents.md#op-updatelibrarydocument) | write |
|
|
1683
|
+
| GET | `/api/v1/library/documents/{document_id}/download` | [`g8.api.documents.downloadLibraryDocument`](documents.md#op-downloadlibrarydocument) | read |
|
|
1684
|
+
| POST | `/api/v1/library/documents/{document_id}/reextract` | [`g8.api.documents.reextractLibraryDocument`](documents.md#op-reextractlibrarydocument) | write |
|
|
1685
|
+
| POST | `/api/v1/library/documents/{document_id}/refresh` | [`g8.api.documents.refreshLibraryDocument`](documents.md#op-refreshlibrarydocument) | write |
|
|
1686
|
+
| POST | `/api/v1/library/documents/{document_id}/restore` | [`g8.api.documents.restoreLibraryDocument`](documents.md#op-restorelibrarydocument) | write |
|
|
1687
|
+
| GET | `/api/v1/library/folders` | [`g8.api.documents.listLibraryFolders`](documents.md#op-listlibraryfolders) | read |
|
|
1688
|
+
| POST | `/api/v1/library/folders` | [`g8.api.documents.createLibraryFolder`](documents.md#op-createlibraryfolder) | write |
|
|
1689
|
+
| DELETE | `/api/v1/library/folders/{folder_id}` | [`g8.api.documents.deleteLibraryFolder`](documents.md#op-deletelibraryfolder) | destructive |
|
|
1690
|
+
| PUT | `/api/v1/library/folders/{folder_id}` | [`g8.api.documents.renameLibraryFolder`](documents.md#op-renamelibraryfolder) | write |
|
|
1691
|
+
| POST | `/api/v1/library/reextract-all` | [`g8.api.library.reextractAllLibraryDocuments`](library.md#op-reextractalllibrarydocuments) | write |
|
|
1692
|
+
| GET | `/api/v1/library/tree` | [`g8.api.documents.getLibraryTree`](documents.md#op-getlibrarytree) | read |
|
|
1693
|
+
| GET | `/api/v1/lifecycle-contacts` | [`g8.api.revenueRecords.listLifecycleContacts`](revenueRecords.md#op-listlifecyclecontacts) | read |
|
|
1694
|
+
| POST | `/api/v1/lifecycle-contacts/unlock` | [`g8.api.revenueRecords.unlockLifecycleContacts`](revenueRecords.md#op-unlocklifecyclecontacts) | billable |
|
|
1695
|
+
| GET | `/api/v1/lifecycle-stages` | [`g8.api.revenueLifecycle.listLifecycleStages`](revenueLifecycle.md#op-listlifecyclestages) | read |
|
|
1696
|
+
| GET | `/api/v1/lifecycle-stages/counts` | [`g8.api.revenueLifecycle.getLifecycleStageCounts`](revenueLifecycle.md#op-getlifecyclestagecounts) | read |
|
|
1697
|
+
| GET | `/api/v1/lifecycle-stages/{stage}/records` | [`g8.api.revenueLifecycle.listLifecycleStageRecords`](revenueLifecycle.md#op-listlifecyclestagerecords) | read |
|
|
1698
|
+
| GET | `/api/v1/linkedin/accounts` | [`g8.api.linkedIn.listLinkedinSenderAccounts`](linkedIn.md#op-listlinkedinsenderaccounts) | read |
|
|
1699
|
+
| POST | `/api/v1/linkedin/accounts/sync` | [`g8.api.linkedIn.syncLinkedinSenderAccounts`](linkedIn.md#op-synclinkedinsenderaccounts) | external |
|
|
1700
|
+
| GET | `/api/v1/linkedin/accounts/{account_id}/schedule` | [`g8.api.linkedIn.getLinkedinAccountSchedule`](linkedIn.md#op-getlinkedinaccountschedule) | read |
|
|
1701
|
+
| PUT | `/api/v1/linkedin/accounts/{account_id}/schedule` | [`g8.api.linkedIn.setLinkedinAccountSchedule`](linkedIn.md#op-setlinkedinaccountschedule) | external |
|
|
1702
|
+
| GET | `/api/v1/linkedin/connection` | [`g8.api.linkedIn.getLinkedinConnectionStatus`](linkedIn.md#op-getlinkedinconnectionstatus) | read |
|
|
1703
|
+
| GET | `/api/v1/lists` | [`g8.api.lists.listLists`](lists.md#op-listlists) or `g8.lists.list()` | read |
|
|
1704
|
+
| POST | `/api/v1/lists` | [`g8.api.lists.createList`](lists.md#op-createlist) or `g8.lists.create()` | write |
|
|
1705
|
+
| POST | `/api/v1/lists/create-empty` | [`g8.api.lists.createEmptyList`](lists.md#op-createemptylist) | write |
|
|
1706
|
+
| GET | `/api/v1/lists/folders` | [`g8.api.lists.listListFolders`](lists.md#op-listlistfolders) | read |
|
|
1707
|
+
| POST | `/api/v1/lists/folders` | [`g8.api.lists.createListFolder`](lists.md#op-createlistfolder) | write |
|
|
1708
|
+
| POST | `/api/v1/lists/folders/activity/{audience_id}` | [`g8.api.lists.recordListOpened`](lists.md#op-recordlistopened) | write |
|
|
1709
|
+
| PUT | `/api/v1/lists/folders/assignments` | [`g8.api.lists.assignListsToFolder`](lists.md#op-assignliststofolder) | write |
|
|
1710
|
+
| PUT | `/api/v1/lists/folders/assignments/{audience_id}` | [`g8.api.lists.assignListToFolder`](lists.md#op-assignlisttofolder) | write |
|
|
1711
|
+
| PUT | `/api/v1/lists/folders/stars/{audience_id}` | [`g8.api.lists.starList`](lists.md#op-starlist) | write |
|
|
1712
|
+
| DELETE | `/api/v1/lists/folders/{folder_id}` | [`g8.api.lists.deleteListFolder`](lists.md#op-deletelistfolder) | destructive |
|
|
1713
|
+
| PATCH | `/api/v1/lists/folders/{folder_id}` | [`g8.api.lists.updateListFolder`](lists.md#op-updatelistfolder) | write |
|
|
1714
|
+
| GET | `/api/v1/lists/masters` | [`g8.api.lists.listMasterLists`](lists.md#op-listmasterlists) | read |
|
|
1715
|
+
| POST | `/api/v1/lists/masters` | [`g8.api.lists.createMasterList`](lists.md#op-createmasterlist) | write |
|
|
1716
|
+
| GET | `/api/v1/lists/performance` | [`g8.api.lists.getListPerformance`](lists.md#op-getlistperformance) | read |
|
|
1717
|
+
| GET | `/api/v1/lists/{audience_id}/column-capabilities` | [`g8.api.lists.getListColumnCapabilities`](lists.md#op-getlistcolumncapabilities) | read |
|
|
1718
|
+
| DELETE | `/api/v1/lists/{audience_id}/companies` | [`g8.api.lists.deleteCompaniesFromList`](lists.md#op-deletecompaniesfromlist) | destructive |
|
|
1719
|
+
| POST | `/api/v1/lists/{audience_id}/deals` | [`g8.api.lists.addDealsToList`](lists.md#op-adddealstolist) | write |
|
|
1720
|
+
| GET | `/api/v1/lists/{audience_id}/download` | [`g8.api.lists.downloadList`](lists.md#op-downloadlist) | read |
|
|
1721
|
+
| PATCH | `/api/v1/lists/{audience_id}/dynamic-value` | [`g8.api.lists.patchDynamicValue`](lists.md#op-patchdynamicvalue) | write |
|
|
1722
|
+
| POST | `/api/v1/lists/{audience_id}/generate-tracked-links` | [`g8.api.lists.generateTrackedLinks`](lists.md#op-generatetrackedlinks) | write |
|
|
1723
|
+
| GET | `/api/v1/lists/{audience_id}/keyword-links` | [`g8.api.lists.getListKeywordLinks`](lists.md#op-getlistkeywordlinks) | read |
|
|
1724
|
+
| DELETE | `/api/v1/lists/{audience_id}/leads` | [`g8.api.lists.deleteLeadsFromList`](lists.md#op-deleteleadsfromlist) | destructive |
|
|
1725
|
+
| PATCH | `/api/v1/lists/{audience_id}/master-config` | [`g8.api.lists.updateMasterListConfig`](lists.md#op-updatemasterlistconfig) | write |
|
|
1726
|
+
| POST | `/api/v1/lists/{audience_id}/master-refresh` | [`g8.api.lists.refreshMasterListNow`](lists.md#op-refreshmasterlistnow) | write |
|
|
1727
|
+
| PATCH | `/api/v1/lists/{audience_id}/owner` | [`g8.api.lists.reassignListOwner`](lists.md#op-reassignlistowner) | write |
|
|
1728
|
+
| GET | `/api/v1/lists/{audience_id}/owner/preview` | [`g8.api.lists.previewListOwnerTransfer`](lists.md#op-previewlistownertransfer) | read |
|
|
1729
|
+
| POST | `/api/v1/lists/{audience_id}/refresh` | [`g8.api.lists.refreshDynamicList`](lists.md#op-refreshdynamiclist) | write |
|
|
1730
|
+
| DELETE | `/api/v1/lists/{audience_id}/suppressions` | [`g8.api.lists.deleteSuppressionsFromList`](lists.md#op-deletesuppressionsfromlist) | destructive |
|
|
1731
|
+
| GET | `/api/v1/lists/{audience_id}/tracked-links/columns` | [`g8.api.lists.getTrackedLinkColumns`](lists.md#op-gettrackedlinkcolumns) | read |
|
|
1732
|
+
| DELETE | `/api/v1/lists/{list_id}` | [`g8.api.lists.deleteList`](lists.md#op-deletelist) or `g8.lists.delete()` | destructive |
|
|
1733
|
+
| PATCH | `/api/v1/lists/{list_id}` | [`g8.api.lists.updateList`](lists.md#op-updatelist) | write |
|
|
1734
|
+
| DELETE | `/api/v1/lists/{list_id}/contacts` | [`g8.api.lists.removeContactsFromList`](lists.md#op-removecontactsfromlist) or `g8.lists.removeContacts()` | destructive |
|
|
1735
|
+
| GET | `/api/v1/lists/{list_id}/contacts` | [`g8.api.lists.getListContacts`](lists.md#op-getlistcontacts) or `g8.lists.contacts()` | read |
|
|
1736
|
+
| POST | `/api/v1/lists/{list_id}/contacts` | [`g8.api.lists.addContactsToList`](lists.md#op-addcontactstolist) or `g8.lists.addContacts()` | write |
|
|
1737
|
+
| GET | `/api/v1/lists/{list_id}/data-columns` | [`g8.api.lists.listDataColumns`](lists.md#op-listdatacolumns) | read |
|
|
1738
|
+
| POST | `/api/v1/lists/{list_id}/integrity-check` | [`g8.api.lists.checkListIntegrity`](lists.md#op-checklistintegrity) | read |
|
|
1739
|
+
| GET | `/api/v1/logs` | [`g8.api.logs.listRequestLogs`](logs.md#op-listrequestlogs) | read |
|
|
1740
|
+
| GET | `/api/v1/mailboxes` | [`g8.api.gtmContext.listMailboxes`](gtmContext.md#op-listmailboxes) or `g8.mailboxes.list()` | read |
|
|
1741
|
+
| POST | `/api/v1/mailboxes` | [`g8.api.mailboxes.createMailbox`](mailboxes.md#op-createmailbox) or `g8.mailboxes.create()` | write |
|
|
1742
|
+
| POST | `/api/v1/mailboxes/bulk-import` | [`g8.api.mailboxes.bulkImportMailboxes`](mailboxes.md#op-bulkimportmailboxes) | write |
|
|
1743
|
+
| GET | `/api/v1/mailboxes/fleet-health` | [`g8.api.mailboxes.getFleetHealth`](mailboxes.md#op-getfleethealth) | read |
|
|
1744
|
+
| GET | `/api/v1/mailboxes/my` | [`g8.api.mailboxes.listMyMailboxes`](mailboxes.md#op-listmymailboxes) | read |
|
|
1745
|
+
| GET | `/api/v1/mailboxes/personas` | [`g8.api.mailboxes.listSenderPersonas`](mailboxes.md#op-listsenderpersonas) | read |
|
|
1746
|
+
| POST | `/api/v1/mailboxes/personas` | [`g8.api.mailboxes.createSenderPersona`](mailboxes.md#op-createsenderpersona) | write |
|
|
1747
|
+
| DELETE | `/api/v1/mailboxes/personas/{persona_id}` | [`g8.api.mailboxes.archivePersona`](mailboxes.md#op-archivepersona) | destructive |
|
|
1748
|
+
| GET | `/api/v1/mailboxes/personas/{persona_id}` | [`g8.api.mailboxes.getSenderPersona`](mailboxes.md#op-getsenderpersona) | read |
|
|
1749
|
+
| PATCH | `/api/v1/mailboxes/personas/{persona_id}` | [`g8.api.mailboxes.updateSenderPersona`](mailboxes.md#op-updatesenderpersona) | write |
|
|
1750
|
+
| POST | `/api/v1/mailboxes/personas/{persona_id}/photo` | [`g8.api.mailboxes.uploadPersonaPhoto`](mailboxes.md#op-uploadpersonaphoto) | write |
|
|
1751
|
+
| POST | `/api/v1/mailboxes/schedule-buy/check-domains` | [`g8.api.scheduleBuy.checkPlanDomains`](scheduleBuy.md#op-checkplandomains) | read |
|
|
1752
|
+
| GET | `/api/v1/mailboxes/schedule-buy/plans` | [`g8.api.scheduleBuy.listPlans`](scheduleBuy.md#op-listplans) | read |
|
|
1753
|
+
| POST | `/api/v1/mailboxes/schedule-buy/plans` | [`g8.api.scheduleBuy.createPlan`](scheduleBuy.md#op-createplan) | billable |
|
|
1754
|
+
| DELETE | `/api/v1/mailboxes/schedule-buy/plans/{plan_id}` | [`g8.api.scheduleBuy.cancelPlan`](scheduleBuy.md#op-cancelplan) | destructive |
|
|
1755
|
+
| GET | `/api/v1/mailboxes/schedule-buy/plans/{plan_id}` | [`g8.api.scheduleBuy.getPlan`](scheduleBuy.md#op-getplan) | read |
|
|
1756
|
+
| POST | `/api/v1/mailboxes/schedule-buy/plans/{plan_id}/pause` | [`g8.api.scheduleBuy.pausePlan`](scheduleBuy.md#op-pauseplan) | write |
|
|
1757
|
+
| POST | `/api/v1/mailboxes/schedule-buy/plans/{plan_id}/resume` | [`g8.api.scheduleBuy.resumePlan`](scheduleBuy.md#op-resumeplan) | billable |
|
|
1758
|
+
| POST | `/api/v1/mailboxes/schedule-buy/suggest` | [`g8.api.scheduleBuy.suggestPlan`](scheduleBuy.md#op-suggestplan) | read |
|
|
1759
|
+
| POST | `/api/v1/mailboxes/schedule-buy/suggest-domains` | [`g8.api.scheduleBuy.suggestPlanDomains`](scheduleBuy.md#op-suggestplandomains) | read |
|
|
1760
|
+
| POST | `/api/v1/mailboxes/uncancel` | [`g8.api.mailboxes.uncancelMailboxes`](mailboxes.md#op-uncancelmailboxes) | billable |
|
|
1761
|
+
| DELETE | `/api/v1/mailboxes/{mailbox_id}` | [`g8.api.mailboxes.deleteMailbox`](mailboxes.md#op-deletemailbox) or `g8.mailboxes.delete()` | destructive |
|
|
1762
|
+
| GET | `/api/v1/mailboxes/{mailbox_id}` | [`g8.api.mailboxes.getMailbox`](mailboxes.md#op-getmailbox) or `g8.mailboxes.get()` | read |
|
|
1763
|
+
| PATCH | `/api/v1/mailboxes/{mailbox_id}` | [`g8.api.mailboxes.updateMailbox`](mailboxes.md#op-updatemailbox) or `g8.mailboxes.update()` | write |
|
|
1764
|
+
| POST | `/api/v1/mailboxes/{mailbox_id}/archive` | [`g8.api.mailboxes.archiveMailbox`](mailboxes.md#op-archivemailbox) | destructive |
|
|
1765
|
+
| GET | `/api/v1/mailboxes/{mailbox_id}/associated-sequences` | [`g8.api.mailboxes.getMailboxAssociatedSequences`](mailboxes.md#op-getmailboxassociatedsequences) | read |
|
|
1766
|
+
| GET | `/api/v1/mailboxes/{mailbox_id}/health` | [`g8.api.mailboxes.getMailboxHealth`](mailboxes.md#op-getmailboxhealth) | read |
|
|
1767
|
+
| POST | `/api/v1/mailboxes/{mailbox_id}/health/placement-test` | [`g8.api.mailboxes.runMailboxPlacementTest`](mailboxes.md#op-runmailboxplacementtest) | billable |
|
|
1768
|
+
| POST | `/api/v1/mailboxes/{mailbox_id}/request-cancellation` | [`g8.api.mailboxes.requestMailboxCancellation`](mailboxes.md#op-requestmailboxcancellation) | destructive |
|
|
1769
|
+
| POST | `/api/v1/mailboxes/{mailbox_id}/share` | [`g8.api.mailboxes.shareMailbox`](mailboxes.md#op-sharemailbox) | write |
|
|
1770
|
+
| POST | `/api/v1/mailboxes/{mailbox_id}/test-connection` | [`g8.api.mailboxes.testMailboxConnection`](mailboxes.md#op-testmailboxconnection) or `g8.mailboxes.testConnection()` | write |
|
|
1771
|
+
| GET | `/api/v1/mailboxes/{mailbox_id}/warmup` | [`g8.api.gtmContext.getMailboxWarmupAnalytics`](gtmContext.md#op-getmailboxwarmupanalytics) or `g8.mailboxes.warmup()` | read |
|
|
1772
|
+
| GET | `/api/v1/manual-products` | [`g8.api.quotes.listManualProducts`](quotes.md#op-listmanualproducts) | read |
|
|
1773
|
+
| POST | `/api/v1/manual-products` | [`g8.api.quotes.createManualProduct`](quotes.md#op-createmanualproduct) | write |
|
|
1774
|
+
| DELETE | `/api/v1/manual-products/{product_id}` | [`g8.api.quotes.deleteManualProduct`](quotes.md#op-deletemanualproduct) | destructive |
|
|
1775
|
+
| PATCH | `/api/v1/manual-products/{product_id}` | [`g8.api.quotes.updateManualProduct`](quotes.md#op-updatemanualproduct) | write |
|
|
1776
|
+
| GET | `/api/v1/marketplace/admin/analytics/funnel` | [`g8.api.marketplace.adminFunnel`](marketplace.md#op-adminfunnel) | read |
|
|
1777
|
+
| GET | `/api/v1/marketplace/admin/analytics/hires` | [`g8.api.marketplace.adminHires`](marketplace.md#op-adminhires) | read |
|
|
1778
|
+
| GET | `/api/v1/marketplace/admin/analytics/operational` | [`g8.api.marketplace.adminOperational`](marketplace.md#op-adminoperational) | read |
|
|
1779
|
+
| GET | `/api/v1/marketplace/admin/analytics/revenue` | [`g8.api.marketplace.adminRevenue`](marketplace.md#op-adminrevenue) | read |
|
|
1780
|
+
| GET | `/api/v1/marketplace/agencies` | [`g8.api.marketplace.listTalentAgencies`](marketplace.md#op-listtalentagencies) | read |
|
|
1781
|
+
| GET | `/api/v1/marketplace/agencies/{slug}` | [`g8.api.marketplace.getTalentAgency`](marketplace.md#op-gettalentagency) | read |
|
|
1782
|
+
| PATCH | `/api/v1/marketplace/agencies/{slug}` | [`g8.api.marketplace.updateAgencyProfile`](marketplace.md#op-updateagencyprofile) | billable |
|
|
1783
|
+
| GET | `/api/v1/marketplace/agencies/{slug}/contracts` | [`g8.api.marketplace.getAgencyContracts`](marketplace.md#op-getagencycontracts) | read |
|
|
1784
|
+
| GET | `/api/v1/marketplace/agencies/{slug}/intake` | [`g8.api.marketplace.getAgencyIntake`](marketplace.md#op-getagencyintake) | read |
|
|
1785
|
+
| POST | `/api/v1/marketplace/agencies/{slug}/intake/upload` | [`g8.api.marketplace.uploadAgencyResumes`](marketplace.md#op-uploadagencyresumes) | billable |
|
|
1786
|
+
| GET | `/api/v1/marketplace/agencies/{slug}/payouts` | [`g8.api.marketplace.getAgencyPayouts`](marketplace.md#op-getagencypayouts) | read |
|
|
1787
|
+
| GET | `/api/v1/marketplace/agencies/{slug}/placements` | [`g8.api.marketplace.getAgencyPlacements`](marketplace.md#op-getagencyplacements) | read |
|
|
1788
|
+
| POST | `/api/v1/marketplace/agencies/{slug}/placements/{hiring_id}/end` | [`g8.api.marketplace.endAgencyPlacement`](marketplace.md#op-endagencyplacement) | destructive |
|
|
1789
|
+
| DELETE | `/api/v1/marketplace/agencies/{slug}/reps/{sdr_id}` | [`g8.api.marketplace.removeAgencyRep`](marketplace.md#op-removeagencyrep) | destructive |
|
|
1790
|
+
| PATCH | `/api/v1/marketplace/agencies/{slug}/reps/{sdr_id}` | [`g8.api.marketplace.editAgencyRep`](marketplace.md#op-editagencyrep) | billable |
|
|
1791
|
+
| POST | `/api/v1/marketplace/agencies/{slug}/reps/{sdr_id}/publish` | [`g8.api.marketplace.publishAgencyRep`](marketplace.md#op-publishagencyrep) | external |
|
|
1792
|
+
| POST | `/api/v1/marketplace/agencies/{slug}/reps/{sdr_id}/unlist` | [`g8.api.marketplace.unlistAgencyRep`](marketplace.md#op-unlistagencyrep) | billable |
|
|
1793
|
+
| DELETE | `/api/v1/marketplace/agencies/{slug}/reps/{sdr_id}/video-intro` | [`g8.api.marketplace.clearAgencyRepVideoIntro`](marketplace.md#op-clearagencyrepvideointro) | destructive |
|
|
1794
|
+
| POST | `/api/v1/marketplace/agencies/{slug}/reps/{sdr_id}/video-intro` | [`g8.api.marketplace.uploadAgencyRepVideoIntro`](marketplace.md#op-uploadagencyrepvideointro) | billable |
|
|
1795
|
+
| GET | `/api/v1/marketplace/agencies/{slug}/requests` | [`g8.api.marketplace.getAgencyOpenRequests`](marketplace.md#op-getagencyopenrequests) | read |
|
|
1796
|
+
| GET | `/api/v1/marketplace/agencies/{slug}/revenue` | [`g8.api.marketplace.getAgencyRevenue`](marketplace.md#op-getagencyrevenue) | read |
|
|
1797
|
+
| GET | `/api/v1/marketplace/agencies/{slug}/roster` | [`g8.api.marketplace.getAgencyRoster`](marketplace.md#op-getagencyroster) | read |
|
|
1798
|
+
| GET | `/api/v1/marketplace/agencies/{slug}/service-statements` | [`g8.api.marketplace.listAgencyStatements`](marketplace.md#op-listagencystatements) | read |
|
|
1799
|
+
| POST | `/api/v1/marketplace/agencies/{slug}/service-statements` | [`g8.api.marketplace.createAgencyStatement`](marketplace.md#op-createagencystatement) | billable |
|
|
1800
|
+
| GET | `/api/v1/marketplace/agencies/{slug}/service-statements/{statement_id}` | [`g8.api.marketplace.getAgencyStatement`](marketplace.md#op-getagencystatement) | read |
|
|
1801
|
+
| PATCH | `/api/v1/marketplace/agencies/{slug}/service-statements/{statement_id}` | [`g8.api.marketplace.updateAgencyStatement`](marketplace.md#op-updateagencystatement) | billable |
|
|
1802
|
+
| GET | `/api/v1/marketplace/agencies/{slug}/service-statements/{statement_id}/line-items` | [`g8.api.marketplace.listAgencyStatementLineItems`](marketplace.md#op-listagencystatementlineitems) | read |
|
|
1803
|
+
| POST | `/api/v1/marketplace/agencies/{slug}/service-statements/{statement_id}/line-items` | [`g8.api.marketplace.addAgencyStatementLineItem`](marketplace.md#op-addagencystatementlineitem) | billable |
|
|
1804
|
+
| POST | `/api/v1/marketplace/agencies/{slug}/service-statements/{statement_id}/submit` | [`g8.api.marketplace.submitAgencyStatement`](marketplace.md#op-submitagencystatement) | billable |
|
|
1805
|
+
| PATCH | `/api/v1/marketplace/applications/{application_id}` | [`g8.api.marketplace.patchMarketplaceApplication`](marketplace.md#op-patchmarketplaceapplication) | billable |
|
|
1806
|
+
| GET | `/api/v1/marketplace/commissions/entries` | [`g8.api.marketplace.listCommissionEntries`](marketplace.md#op-listcommissionentries) | read |
|
|
1807
|
+
| POST | `/api/v1/marketplace/commissions/entries` | [`g8.api.marketplace.recordCommissionEntry`](marketplace.md#op-recordcommissionentry) | billable |
|
|
1808
|
+
| POST | `/api/v1/marketplace/commissions/entries/{entry_id}/quality` | [`g8.api.marketplace.resolveCommissionQuality`](marketplace.md#op-resolvecommissionquality) | billable |
|
|
1809
|
+
| POST | `/api/v1/marketplace/commissions/entries/{entry_id}/reversals` | [`g8.api.marketplace.reverseCommissionEntry`](marketplace.md#op-reversecommissionentry) | billable |
|
|
1810
|
+
| POST | `/api/v1/marketplace/commissions/entries/{entry_id}/statement` | [`g8.api.marketplace.allocateCommissionEntry`](marketplace.md#op-allocatecommissionentry) | billable |
|
|
1811
|
+
| GET | `/api/v1/marketplace/commissions/plans` | [`g8.api.marketplace.listCommissionPlans`](marketplace.md#op-listcommissionplans) | read |
|
|
1812
|
+
| POST | `/api/v1/marketplace/commissions/plans` | [`g8.api.marketplace.createCommissionPlan`](marketplace.md#op-createcommissionplan) | billable |
|
|
1813
|
+
| POST | `/api/v1/marketplace/commissions/plans/{version_id}/activate` | [`g8.api.marketplace.activateCommissionPlan`](marketplace.md#op-activatecommissionplan) | billable |
|
|
1814
|
+
| POST | `/api/v1/marketplace/commissions/preview` | [`g8.api.marketplace.previewCommission`](marketplace.md#op-previewcommission) | billable |
|
|
1815
|
+
| GET | `/api/v1/marketplace/contracts/{hiring_id}` | [`g8.api.marketplace.getMarketplaceContract`](marketplace.md#op-getmarketplacecontract) | read |
|
|
1816
|
+
| GET | `/api/v1/marketplace/conversations` | [`g8.api.marketplace.listMarketplaceConversations`](marketplace.md#op-listmarketplaceconversations) | read |
|
|
1817
|
+
| POST | `/api/v1/marketplace/conversations/{conversation_id}/read` | [`g8.api.marketplace.markMarketplaceConversationRead`](marketplace.md#op-markmarketplaceconversationread) | billable |
|
|
1818
|
+
| PATCH | `/api/v1/marketplace/conversations/{conversation_id}/state` | [`g8.api.marketplace.setMarketplaceConversationState`](marketplace.md#op-setmarketplaceconversationstate) | billable |
|
|
1819
|
+
| GET | `/api/v1/marketplace/job-posts` | [`g8.api.marketplace.listMarketplaceJobPosts`](marketplace.md#op-listmarketplacejobposts) | read |
|
|
1820
|
+
| POST | `/api/v1/marketplace/job-posts` | [`g8.api.marketplace.createMarketplaceJobPost`](marketplace.md#op-createmarketplacejobpost) | billable |
|
|
1821
|
+
| DELETE | `/api/v1/marketplace/job-posts/{post_id}` | [`g8.api.marketplace.deleteMarketplaceJobPost`](marketplace.md#op-deletemarketplacejobpost) | destructive |
|
|
1822
|
+
| GET | `/api/v1/marketplace/job-posts/{post_id}` | [`g8.api.marketplace.getMarketplaceJobPost`](marketplace.md#op-getmarketplacejobpost) | read |
|
|
1823
|
+
| PATCH | `/api/v1/marketplace/job-posts/{post_id}` | [`g8.api.marketplace.updateMarketplaceJobPost`](marketplace.md#op-updatemarketplacejobpost) | billable |
|
|
1824
|
+
| GET | `/api/v1/marketplace/job-posts/{post_id}/applications` | [`g8.api.marketplace.listMarketplaceJobPostApplications`](marketplace.md#op-listmarketplacejobpostapplications) | read |
|
|
1825
|
+
| POST | `/api/v1/marketplace/job-posts/{post_id}/jd` | [`g8.api.marketplace.uploadJobPostJd`](marketplace.md#op-uploadjobpostjd) | billable |
|
|
1826
|
+
| GET | `/api/v1/marketplace/me/agency` | [`g8.api.marketplace.getMyAgency`](marketplace.md#op-getmyagency) | read |
|
|
1827
|
+
| GET | `/api/v1/marketplace/me/applications` | [`g8.api.marketplace.listMyMarketplaceApplications`](marketplace.md#op-listmymarketplaceapplications) | read |
|
|
1828
|
+
| GET | `/api/v1/marketplace/me/connect/dashboard-link` | [`g8.api.marketplace.getMyConnectDashboardLink`](marketplace.md#op-getmyconnectdashboardlink) | external |
|
|
1829
|
+
| GET | `/api/v1/marketplace/me/connect/onboarding-link` | [`g8.api.marketplace.getMyConnectOnboardingLink`](marketplace.md#op-getmyconnectonboardinglink) | external |
|
|
1830
|
+
| GET | `/api/v1/marketplace/me/connect/status` | [`g8.api.marketplace.getMyConnectStatus`](marketplace.md#op-getmyconnectstatus) | read |
|
|
1831
|
+
| GET | `/api/v1/marketplace/me/contracts` | [`g8.api.marketplace.listMyMarketplaceContracts`](marketplace.md#op-listmymarketplacecontracts) | read |
|
|
1832
|
+
| POST | `/api/v1/marketplace/me/headshot` | [`g8.api.marketplace.uploadMyHeadshot`](marketplace.md#op-uploadmyheadshot) | billable |
|
|
1833
|
+
| GET | `/api/v1/marketplace/me/hirings` | [`g8.api.marketplace.listMyMarketplaceHirings`](marketplace.md#op-listmymarketplacehirings) or `g8.marketplace.hirings()` | read |
|
|
1834
|
+
| GET | `/api/v1/marketplace/me/invoices` | [`g8.api.marketplace.listMyMarketplaceInvoices`](marketplace.md#op-listmymarketplaceinvoices) | read |
|
|
1835
|
+
| POST | `/api/v1/marketplace/me/invoices` | [`g8.api.marketplace.submitMyInvoice`](marketplace.md#op-submitmyinvoice) | billable |
|
|
1836
|
+
| PUT | `/api/v1/marketplace/me/invoices/{invoice_id}` | [`g8.api.marketplace.annotateMyInvoice`](marketplace.md#op-annotatemyinvoice) | billable |
|
|
1837
|
+
| POST | `/api/v1/marketplace/me/invoices/{invoice_id}/approve` | [`g8.api.marketplace.approveMyInvoice`](marketplace.md#op-approvemyinvoice) | billable |
|
|
1838
|
+
| GET | `/api/v1/marketplace/me/mcp-access` | [`g8.api.marketplace.getMyMcpAccess`](marketplace.md#op-getmymcpaccess) | read |
|
|
1839
|
+
| GET | `/api/v1/marketplace/me/meetings` | [`g8.api.marketplace.listMyMeetings`](marketplace.md#op-listmymeetings) | read |
|
|
1840
|
+
| GET | `/api/v1/marketplace/me/meetings/{meeting_id}` | [`g8.api.marketplace.getMyMeeting`](marketplace.md#op-getmymeeting) | read |
|
|
1841
|
+
| PATCH | `/api/v1/marketplace/me/meetings/{meeting_id}` | [`g8.api.marketplace.updateMyMeeting`](marketplace.md#op-updatemymeeting) | billable |
|
|
1842
|
+
| GET | `/api/v1/marketplace/me/messages` | [`g8.api.marketplace.listMyConversations`](marketplace.md#op-listmyconversations) | read |
|
|
1843
|
+
| POST | `/api/v1/marketplace/me/messages/{conversation_id}/read` | [`g8.api.marketplace.markMyConversationRead`](marketplace.md#op-markmyconversationread) | billable |
|
|
1844
|
+
| POST | `/api/v1/marketplace/me/messages/{conversation_id}/reply` | [`g8.api.marketplace.replyToMarketplaceConversation`](marketplace.md#op-replytomarketplaceconversation) | external |
|
|
1845
|
+
| PATCH | `/api/v1/marketplace/me/messages/{conversation_id}/state` | [`g8.api.marketplace.setMyConversationState`](marketplace.md#op-setmyconversationstate) | billable |
|
|
1846
|
+
| GET | `/api/v1/marketplace/me/offers` | [`g8.api.marketplace.listMyMarketplaceOffers`](marketplace.md#op-listmymarketplaceoffers) or `g8.marketplace.offers()` | read |
|
|
1847
|
+
| POST | `/api/v1/marketplace/me/offers/{hiring_id}/accept` | [`g8.api.marketplace.acceptMyOffer`](marketplace.md#op-acceptmyoffer) or `g8.marketplace.acceptOffer()` | billable |
|
|
1848
|
+
| POST | `/api/v1/marketplace/me/offers/{hiring_id}/reject` | [`g8.api.marketplace.rejectMyOffer`](marketplace.md#op-rejectmyoffer) or `g8.marketplace.rejectOffer()` | billable |
|
|
1849
|
+
| GET | `/api/v1/marketplace/me/payout-account` | [`g8.api.marketplace.getMyPayoutAccount`](marketplace.md#op-getmypayoutaccount) | read |
|
|
1850
|
+
| POST | `/api/v1/marketplace/me/payout-account/bank-details` | [`g8.api.marketplace.submitMyBankDetails`](marketplace.md#op-submitmybankdetails) | external |
|
|
1851
|
+
| GET | `/api/v1/marketplace/me/payout-account/bank-requirements` | [`g8.api.marketplace.getMyBankRequirements`](marketplace.md#op-getmybankrequirements) | read |
|
|
1852
|
+
| POST | `/api/v1/marketplace/me/payout-account/fallback` | [`g8.api.marketplace.fallBackToWise`](marketplace.md#op-fallbacktowise) | destructive |
|
|
1853
|
+
| GET | `/api/v1/marketplace/me/payout-account/login-link` | [`g8.api.marketplace.getMyPayoutLoginLink`](marketplace.md#op-getmypayoutloginlink) | external |
|
|
1854
|
+
| GET | `/api/v1/marketplace/me/payout-account/methods` | [`g8.api.marketplace.listMyPayoutMethods`](marketplace.md#op-listmypayoutmethods) | read |
|
|
1855
|
+
| POST | `/api/v1/marketplace/me/payout-account/methods` | [`g8.api.marketplace.addMyPayoutMethod`](marketplace.md#op-addmypayoutmethod) | external |
|
|
1856
|
+
| DELETE | `/api/v1/marketplace/me/payout-account/methods/{account_id}` | [`g8.api.marketplace.deleteMyPayoutMethod`](marketplace.md#op-deletemypayoutmethod) | destructive |
|
|
1857
|
+
| POST | `/api/v1/marketplace/me/payout-account/methods/{account_id}/set-primary` | [`g8.api.marketplace.setMyPrimaryPayoutMethod`](marketplace.md#op-setmyprimarypayoutmethod) | destructive |
|
|
1858
|
+
| GET | `/api/v1/marketplace/me/payout-account/onboarding-link` | [`g8.api.marketplace.getMyPayoutOnboardingLink`](marketplace.md#op-getmypayoutonboardinglink) | external |
|
|
1859
|
+
| POST | `/api/v1/marketplace/me/payout-account/setup` | [`g8.api.marketplace.setUpMyPayoutAccount`](marketplace.md#op-setupmypayoutaccount) | external |
|
|
1860
|
+
| POST | `/api/v1/marketplace/me/payout-account/w8-certify` | [`g8.api.marketplace.certifyMyW8`](marketplace.md#op-certifymyw8) | billable |
|
|
1861
|
+
| GET | `/api/v1/marketplace/me/payout-account/w8-status` | [`g8.api.marketplace.getMyW8Status`](marketplace.md#op-getmyw8status) | read |
|
|
1862
|
+
| GET | `/api/v1/marketplace/me/payouts` | [`g8.api.marketplace.listMyPayouts`](marketplace.md#op-listmypayouts) | read |
|
|
1863
|
+
| GET | `/api/v1/marketplace/me/profile` | [`g8.api.marketplace.getMyMarketplaceProfile`](marketplace.md#op-getmymarketplaceprofile) or `g8.marketplace.profile()` | read |
|
|
1864
|
+
| PATCH | `/api/v1/marketplace/me/profile` | [`g8.api.marketplace.updateMyMarketplaceProfile`](marketplace.md#op-updatemymarketplaceprofile) | billable |
|
|
1865
|
+
| PUT | `/api/v1/marketplace/me/rates` | [`g8.api.marketplace.updateMyRateCard`](marketplace.md#op-updatemyratecard) | billable |
|
|
1866
|
+
| POST | `/api/v1/marketplace/me/resume` | [`g8.api.marketplace.uploadMyResume`](marketplace.md#op-uploadmyresume) | billable |
|
|
1867
|
+
| GET | `/api/v1/marketplace/me/service-statements` | [`g8.api.marketplace.listMyServiceStatements`](marketplace.md#op-listmyservicestatements) | read |
|
|
1868
|
+
| POST | `/api/v1/marketplace/me/service-statements` | [`g8.api.marketplace.createMyServiceStatement`](marketplace.md#op-createmyservicestatement) | billable |
|
|
1869
|
+
| DELETE | `/api/v1/marketplace/me/service-statements/{statement_id}` | [`g8.api.marketplace.deleteMyServiceStatement`](marketplace.md#op-deletemyservicestatement) | destructive |
|
|
1870
|
+
| GET | `/api/v1/marketplace/me/service-statements/{statement_id}` | [`g8.api.marketplace.getMyServiceStatement`](marketplace.md#op-getmyservicestatement) | read |
|
|
1871
|
+
| PATCH | `/api/v1/marketplace/me/service-statements/{statement_id}` | [`g8.api.marketplace.updateMyServiceStatement`](marketplace.md#op-updatemyservicestatement) | billable |
|
|
1872
|
+
| GET | `/api/v1/marketplace/me/service-statements/{statement_id}/line-items` | [`g8.api.marketplace.listMyStatementLineItems`](marketplace.md#op-listmystatementlineitems) | read |
|
|
1873
|
+
| POST | `/api/v1/marketplace/me/service-statements/{statement_id}/line-items` | [`g8.api.marketplace.addMyStatementLineItem`](marketplace.md#op-addmystatementlineitem) | billable |
|
|
1874
|
+
| DELETE | `/api/v1/marketplace/me/service-statements/{statement_id}/line-items/{item_id}` | [`g8.api.marketplace.deleteMyStatementLineItem`](marketplace.md#op-deletemystatementlineitem) | destructive |
|
|
1875
|
+
| POST | `/api/v1/marketplace/me/service-statements/{statement_id}/revise` | [`g8.api.marketplace.reviseMyServiceStatement`](marketplace.md#op-revisemyservicestatement) | billable |
|
|
1876
|
+
| POST | `/api/v1/marketplace/me/service-statements/{statement_id}/submit` | [`g8.api.marketplace.submitMyServiceStatement`](marketplace.md#op-submitmyservicestatement) | billable |
|
|
1877
|
+
| POST | `/api/v1/marketplace/me/sync-workbench` | [`g8.api.marketplace.syncMyWorkbench`](marketplace.md#op-syncmyworkbench) | external |
|
|
1878
|
+
| POST | `/api/v1/marketplace/me/video-intro` | [`g8.api.marketplace.uploadMyVideoIntro`](marketplace.md#op-uploadmyvideointro) | billable |
|
|
1879
|
+
| GET | `/api/v1/marketplace/me/wizard-status` | [`g8.api.marketplace.getMyWizardStatus`](marketplace.md#op-getmywizardstatus) | read |
|
|
1880
|
+
| GET | `/api/v1/marketplace/me/work-certificates` | [`g8.api.marketplace.listMyWorkCertificates`](marketplace.md#op-listmyworkcertificates) | read |
|
|
1881
|
+
| POST | `/api/v1/marketplace/me/work-certificates` | [`g8.api.marketplace.issueMyWorkCertificate`](marketplace.md#op-issuemyworkcertificate) | billable |
|
|
1882
|
+
| GET | `/api/v1/marketplace/opportunities` | [`g8.api.marketplace.listMarketplaceOpportunities`](marketplace.md#op-listmarketplaceopportunities) | read |
|
|
1883
|
+
| GET | `/api/v1/marketplace/opportunities/{post_id}` | [`g8.api.marketplace.getMarketplaceOpportunity`](marketplace.md#op-getmarketplaceopportunity) | read |
|
|
1884
|
+
| POST | `/api/v1/marketplace/opportunities/{post_id}/apply` | [`g8.api.marketplace.applyToMarketplaceOpportunity`](marketplace.md#op-applytomarketplaceopportunity) | billable |
|
|
1885
|
+
| GET | `/api/v1/marketplace/org/hirings` | [`g8.api.marketplace.listOrgMarketplaceHirings`](marketplace.md#op-listorgmarketplacehirings) | read |
|
|
1886
|
+
| GET | `/api/v1/marketplace/org/hirings/{hiring_id}` | [`g8.api.marketplace.getOrgHiring`](marketplace.md#op-getorghiring) | read |
|
|
1887
|
+
| POST | `/api/v1/marketplace/org/hirings/{hiring_id}/meetings` | [`g8.api.marketplace.createOrgHiringMeeting`](marketplace.md#op-createorghiringmeeting) | billable |
|
|
1888
|
+
| POST | `/api/v1/marketplace/org/hirings/{hiring_id}/terminate` | [`g8.api.marketplace.terminateOrgHiring`](marketplace.md#op-terminateorghiring) | billable |
|
|
1889
|
+
| POST | `/api/v1/marketplace/org/hirings/{hiring_id}/withdraw` | [`g8.api.marketplace.withdrawOrgHiring`](marketplace.md#op-withdraworghiring) | billable |
|
|
1890
|
+
| GET | `/api/v1/marketplace/org/invoices` | [`g8.api.marketplace.listOrgMarketplaceInvoices`](marketplace.md#op-listorgmarketplaceinvoices) | read |
|
|
1891
|
+
| GET | `/api/v1/marketplace/org/invoices/{invoice_id}` | [`g8.api.marketplace.getOrgInvoice`](marketplace.md#op-getorginvoice) | read |
|
|
1892
|
+
| POST | `/api/v1/marketplace/org/invoices/{invoice_id}/approve` | [`g8.api.marketplace.approveOrgInvoice`](marketplace.md#op-approveorginvoice) | billable |
|
|
1893
|
+
| POST | `/api/v1/marketplace/org/invoices/{invoice_id}/dispute` | [`g8.api.marketplace.disputeOrgInvoice`](marketplace.md#op-disputeorginvoice) | billable |
|
|
1894
|
+
| GET | `/api/v1/marketplace/org/meetings` | [`g8.api.marketplace.listOrgMarketplaceMeetings`](marketplace.md#op-listorgmarketplacemeetings) | read |
|
|
1895
|
+
| GET | `/api/v1/marketplace/org/meetings/{meeting_id}` | [`g8.api.marketplace.getOrgMarketplaceMeeting`](marketplace.md#op-getorgmarketplacemeeting) | read |
|
|
1896
|
+
| PATCH | `/api/v1/marketplace/org/meetings/{meeting_id}` | [`g8.api.marketplace.updateOrgMarketplaceMeeting`](marketplace.md#op-updateorgmarketplacemeeting) | billable |
|
|
1897
|
+
| GET | `/api/v1/marketplace/org/service-statements` | [`g8.api.marketplace.listOrgServiceStatements`](marketplace.md#op-listorgservicestatements) | read |
|
|
1898
|
+
| GET | `/api/v1/marketplace/org/service-statements/{statement_id}` | [`g8.api.marketplace.getOrgServiceStatement`](marketplace.md#op-getorgservicestatement) | read |
|
|
1899
|
+
| POST | `/api/v1/marketplace/org/service-statements/{statement_id}/approve` | [`g8.api.marketplace.approveOrgServiceStatement`](marketplace.md#op-approveorgservicestatement) | billable |
|
|
1900
|
+
| GET | `/api/v1/marketplace/org/service-statements/{statement_id}/checkout-url` | [`g8.api.marketplace.getOrgStatementCheckoutUrl`](marketplace.md#op-getorgstatementcheckouturl) | read |
|
|
1901
|
+
| GET | `/api/v1/marketplace/org/service-statements/{statement_id}/line-items` | [`g8.api.marketplace.listOrgStatementLineItems`](marketplace.md#op-listorgstatementlineitems) | read |
|
|
1902
|
+
| POST | `/api/v1/marketplace/org/service-statements/{statement_id}/line-items` | [`g8.api.marketplace.addOrgStatementLineItem`](marketplace.md#op-addorgstatementlineitem) | billable |
|
|
1903
|
+
| DELETE | `/api/v1/marketplace/org/service-statements/{statement_id}/line-items/{item_id}` | [`g8.api.marketplace.deleteOrgStatementLineItem`](marketplace.md#op-deleteorgstatementlineitem) | destructive |
|
|
1904
|
+
| POST | `/api/v1/marketplace/org/service-statements/{statement_id}/reject` | [`g8.api.marketplace.rejectOrgServiceStatement`](marketplace.md#op-rejectorgservicestatement) | billable |
|
|
1905
|
+
| POST | `/api/v1/marketplace/org/service-statements/{statement_id}/request-changes` | [`g8.api.marketplace.requestChangesOnOrgStatement`](marketplace.md#op-requestchangesonorgstatement) | billable |
|
|
1906
|
+
| POST | `/api/v1/marketplace/shortlist/export` | [`g8.api.marketplace.exportMarketplaceShortlist`](marketplace.md#op-exportmarketplaceshortlist) | billable |
|
|
1907
|
+
| GET | `/api/v1/marketplace/talent` | [`g8.api.marketplace.browseTalent`](marketplace.md#op-browsetalent) | read |
|
|
1908
|
+
| GET | `/api/v1/marketplace/talent/{sdr_id}` | [`g8.api.marketplace.getTalentProfile`](marketplace.md#op-gettalentprofile) | read |
|
|
1909
|
+
| POST | `/api/v1/marketplace/talent/{sdr_id}/hire` | [`g8.api.marketplace.hireTalent`](marketplace.md#op-hiretalent) | billable |
|
|
1910
|
+
| GET | `/api/v1/marketplace/talent/{sdr_id}/match` | [`g8.api.marketplace.getTalentMatch`](marketplace.md#op-gettalentmatch) | read |
|
|
1911
|
+
| POST | `/api/v1/marketplace/talent/{sdr_id}/match/analyze` | [`g8.api.marketplace.analyzeTalentMatch`](marketplace.md#op-analyzetalentmatch) | billable |
|
|
1912
|
+
| POST | `/api/v1/marketplace/talent/{sdr_id}/match/refresh` | [`g8.api.marketplace.refreshTalentMatch`](marketplace.md#op-refreshtalentmatch) | billable |
|
|
1913
|
+
| GET | `/api/v1/marketplace/talent/{sdr_id}/messages` | [`g8.api.marketplace.getTalentConversation`](marketplace.md#op-gettalentconversation) | read |
|
|
1914
|
+
| POST | `/api/v1/marketplace/talent/{sdr_id}/messages` | [`g8.api.marketplace.sendTalentMessage`](marketplace.md#op-sendtalentmessage) | external |
|
|
1915
|
+
| POST | `/api/v1/marketplace/talent/{sdr_id}/request` | [`g8.api.marketplace.requestTalentThroughAgency`](marketplace.md#op-requesttalentthroughagency) | external |
|
|
1916
|
+
| POST | `/api/v1/marketplace/terms-acknowledgements/ack-all` | [`g8.api.marketplace.acknowledgeAllPendingTerms`](marketplace.md#op-acknowledgeallpendingterms) | billable |
|
|
1917
|
+
| GET | `/api/v1/marketplace/terms-acknowledgements/pending` | [`g8.api.marketplace.listPendingTermsAcknowledgements`](marketplace.md#op-listpendingtermsacknowledgements) | read |
|
|
1918
|
+
| GET | `/api/v1/mcp/connection` | [`g8.api.mcp.getMcpConnection`](mcp.md#op-getmcpconnection) | read |
|
|
1919
|
+
| GET | `/api/v1/me` | [`g8.api.me.describeCurrentKey`](me.md#op-describecurrentkey) | read |
|
|
1920
|
+
| GET | `/api/v1/meeting-transcripts` | [`g8.api.meetings.listMeetingTranscripts`](meetings.md#op-listmeetingtranscripts) | read |
|
|
1921
|
+
| GET | `/api/v1/meeting-transcripts/coaching-queue` | [`g8.api.meetings.getMeetingCoachingQueue`](meetings.md#op-getmeetingcoachingqueue) | read |
|
|
1922
|
+
| GET | `/api/v1/meeting-transcripts/stats` | [`g8.api.meetings.getMeetingTranscriptStats`](meetings.md#op-getmeetingtranscriptstats) | read |
|
|
1923
|
+
| DELETE | `/api/v1/meeting-transcripts/{transcript_id}` | [`g8.api.meetings.deleteMeetingTranscript`](meetings.md#op-deletemeetingtranscript) | destructive |
|
|
1924
|
+
| GET | `/api/v1/meeting-transcripts/{transcript_id}` | [`g8.api.meetings.getMeetingTranscript`](meetings.md#op-getmeetingtranscript) | read |
|
|
1925
|
+
| PATCH | `/api/v1/meeting-transcripts/{transcript_id}/account` | [`g8.api.meetings.linkMeetingTranscriptAccount`](meetings.md#op-linkmeetingtranscriptaccount) | write |
|
|
1926
|
+
| POST | `/api/v1/meeting-transcripts/{transcript_id}/follow-up-draft` | [`g8.api.meetings.draftMeetingFollowUp`](meetings.md#op-draftmeetingfollowup) | billable |
|
|
1927
|
+
| GET | `/api/v1/meeting-transcripts/{transcript_id}/review` | [`g8.api.meetings.getMeetingReview`](meetings.md#op-getmeetingreview) | read |
|
|
1928
|
+
| POST | `/api/v1/meeting-transcripts/{transcript_id}/review/acknowledge` | [`g8.api.meetings.acknowledgeMeetingReview`](meetings.md#op-acknowledgemeetingreview) | write |
|
|
1929
|
+
| POST | `/api/v1/meeting-transcripts/{transcript_id}/review/regenerate` | [`g8.api.meetings.regenerateMeetingReview`](meetings.md#op-regeneratemeetingreview) | billable |
|
|
1930
|
+
| GET | `/api/v1/newsletters` | [`g8.api.newsletter.listNewsletters`](newsletter.md#op-listnewsletters) or `g8.newsletter.list()` | read |
|
|
1931
|
+
| POST | `/api/v1/newsletters` | [`g8.api.newsletter.createNewsletter`](newsletter.md#op-createnewsletter) or `g8.newsletter.create()` | external |
|
|
1932
|
+
| GET | `/api/v1/newsletters/templates` | [`g8.api.newsletter.listTemplates`](newsletter.md#op-listtemplates) or `g8.newsletter.templates()` | read |
|
|
1933
|
+
| POST | `/api/v1/newsletters/templates/clone` | [`g8.api.newsletter.cloneTemplate`](newsletter.md#op-clonetemplate) | billable |
|
|
1934
|
+
| POST | `/api/v1/newsletters/templates/custom` | [`g8.api.newsletter.createTemplateFromPrompt`](newsletter.md#op-createtemplatefromprompt) | billable |
|
|
1935
|
+
| POST | `/api/v1/newsletters/templates/generation-status` | [`g8.api.newsletter.batchTemplateGenerationStatus`](newsletter.md#op-batchtemplategenerationstatus) | read |
|
|
1936
|
+
| POST | `/api/v1/newsletters/templates/layout` | [`g8.api.newsletter.createTemplateFromLayout`](newsletter.md#op-createtemplatefromlayout) | billable |
|
|
1937
|
+
| DELETE | `/api/v1/newsletters/templates/{template_id}` | [`g8.api.newsletter.deleteNewsletterTemplate`](newsletter.md#op-deletenewslettertemplate) | destructive |
|
|
1938
|
+
| PATCH | `/api/v1/newsletters/templates/{template_id}` | [`g8.api.newsletter.updateNewsletterTemplate`](newsletter.md#op-updatenewslettertemplate) | write |
|
|
1939
|
+
| POST | `/api/v1/newsletters/templates/{template_id}/approval` | [`g8.api.newsletter.setTemplateApproval`](newsletter.md#op-settemplateapproval) | write |
|
|
1940
|
+
| GET | `/api/v1/newsletters/templates/{template_id}/generation-status` | [`g8.api.newsletter.templateGenerationStatus`](newsletter.md#op-templategenerationstatus) | read |
|
|
1941
|
+
| POST | `/api/v1/newsletters/templates/{template_id}/set-button-action` | [`g8.api.newsletter.setTemplateButtonAction`](newsletter.md#op-settemplatebuttonaction) | write |
|
|
1942
|
+
| POST | `/api/v1/newsletters/templates/{template_id}/set-media-edit` | [`g8.api.newsletter.setTemplateMediaEdit`](newsletter.md#op-settemplatemediaedit) | write |
|
|
1943
|
+
| POST | `/api/v1/newsletters/templates/{template_id}/use` | [`g8.api.newsletter.useTemplate`](newsletter.md#op-usetemplate) | write |
|
|
1944
|
+
| GET | `/api/v1/newsletters/{newsletter_id}` | [`g8.api.newsletter.getNewsletter`](newsletter.md#op-getnewsletter) or `g8.newsletter.get()` | read |
|
|
1945
|
+
| PATCH | `/api/v1/newsletters/{newsletter_id}` | [`g8.api.newsletter.updateNewsletter`](newsletter.md#op-updatenewsletter) | write |
|
|
1946
|
+
| POST | `/api/v1/newsletters/{newsletter_id}/activate` | [`g8.api.newsletter.activateNewsletter`](newsletter.md#op-activatenewsletter) | external |
|
|
1947
|
+
| DELETE | `/api/v1/newsletters/{newsletter_id}/campaign` | [`g8.api.newsletter.unlinkNewsletterCampaign`](newsletter.md#op-unlinknewslettercampaign) | destructive |
|
|
1948
|
+
| PUT | `/api/v1/newsletters/{newsletter_id}/campaign` | [`g8.api.newsletter.linkNewsletterCampaign`](newsletter.md#op-linknewslettercampaign) | write |
|
|
1949
|
+
| POST | `/api/v1/newsletters/{newsletter_id}/complete` | [`g8.api.newsletter.completeNewsletter`](newsletter.md#op-completenewsletter) | write |
|
|
1950
|
+
| GET | `/api/v1/newsletters/{newsletter_id}/issues` | [`g8.api.newsletter.listIssues`](newsletter.md#op-listissues) or `g8.newsletter.listIssues()` | read |
|
|
1951
|
+
| POST | `/api/v1/newsletters/{newsletter_id}/issues` | [`g8.api.newsletter.createIssue`](newsletter.md#op-createissue) or `g8.newsletter.createIssue()` | external |
|
|
1952
|
+
| DELETE | `/api/v1/newsletters/{newsletter_id}/issues/{issue_id}` | [`g8.api.newsletter.deleteIssue`](newsletter.md#op-deleteissue) | destructive |
|
|
1953
|
+
| GET | `/api/v1/newsletters/{newsletter_id}/issues/{issue_id}` | [`g8.api.newsletter.getIssue`](newsletter.md#op-getissue) or `g8.newsletter.getIssue()` | read |
|
|
1954
|
+
| PUT | `/api/v1/newsletters/{newsletter_id}/issues/{issue_id}` | [`g8.api.newsletter.updateIssue`](newsletter.md#op-updateissue) or `g8.newsletter.updateIssue()` | external |
|
|
1955
|
+
| GET | `/api/v1/newsletters/{newsletter_id}/issues/{issue_id}/analytics/kpis` | [`g8.api.newsletter.getIssueAnalyticsKpis`](newsletter.md#op-getissueanalyticskpis) or `g8.newsletter.issueKpis()` | read |
|
|
1956
|
+
| GET | `/api/v1/newsletters/{newsletter_id}/issues/{issue_id}/analytics/subscribers/{subscriber_id}/timeline` | [`g8.api.newsletter.getSubscriberTimeline`](newsletter.md#op-getsubscribertimeline) | read |
|
|
1957
|
+
| GET | `/api/v1/newsletters/{newsletter_id}/issues/{issue_id}/conversation` | [`g8.api.newsletter.getNewsletterIssueConversation`](newsletter.md#op-getnewsletterissueconversation) | read |
|
|
1958
|
+
| POST | `/api/v1/newsletters/{newsletter_id}/issues/{issue_id}/duplicate` | [`g8.api.newsletter.duplicateIssue`](newsletter.md#op-duplicateissue) or `g8.newsletter.duplicateIssue()` | external |
|
|
1959
|
+
| POST | `/api/v1/newsletters/{newsletter_id}/issues/{issue_id}/generate` | [`g8.api.newsletter.generateNewsletterIssue`](newsletter.md#op-generatenewsletterissue) | billable |
|
|
1960
|
+
| GET | `/api/v1/newsletters/{newsletter_id}/issues/{issue_id}/generation-status` | [`g8.api.newsletter.getIssueGenerationStatus`](newsletter.md#op-getissuegenerationstatus) | read |
|
|
1961
|
+
| POST | `/api/v1/newsletters/{newsletter_id}/issues/{issue_id}/rewrite-text` | [`g8.api.newsletter.rewriteIssueText`](newsletter.md#op-rewriteissuetext) | billable |
|
|
1962
|
+
| GET | `/api/v1/newsletters/{newsletter_id}/issues/{issue_id}/send` | [`g8.api.newsletter.getSendStatus`](newsletter.md#op-getsendstatus) | read |
|
|
1963
|
+
| POST | `/api/v1/newsletters/{newsletter_id}/issues/{issue_id}/send` | [`g8.api.newsletter.sendIssue`](newsletter.md#op-sendissue) or `g8.newsletter.sendIssue()` | external |
|
|
1964
|
+
| POST | `/api/v1/newsletters/{newsletter_id}/issues/{issue_id}/send-test` | [`g8.api.newsletter.sendTestEmail`](newsletter.md#op-sendtestemail) or `g8.newsletter.sendTestEmail()` | external |
|
|
1965
|
+
| POST | `/api/v1/newsletters/{newsletter_id}/issues/{issue_id}/send/cancel` | [`g8.api.newsletter.cancelSend`](newsletter.md#op-cancelsend) | write |
|
|
1966
|
+
| POST | `/api/v1/newsletters/{newsletter_id}/issues/{issue_id}/send/pause` | [`g8.api.newsletter.pauseSend`](newsletter.md#op-pausesend) | write |
|
|
1967
|
+
| POST | `/api/v1/newsletters/{newsletter_id}/issues/{issue_id}/send/resume` | [`g8.api.newsletter.resumeSend`](newsletter.md#op-resumesend) | external |
|
|
1968
|
+
| POST | `/api/v1/newsletters/{newsletter_id}/issues/{issue_id}/set-button-action` | [`g8.api.newsletter.setIssueButtonAction`](newsletter.md#op-setissuebuttonaction) | write |
|
|
1969
|
+
| POST | `/api/v1/newsletters/{newsletter_id}/issues/{issue_id}/set-media-edit` | [`g8.api.newsletter.setIssueMediaEdit`](newsletter.md#op-setissuemediaedit) | write |
|
|
1970
|
+
| POST | `/api/v1/newsletters/{newsletter_id}/issues/{issue_id}/set-text` | [`g8.api.newsletter.setIssueText`](newsletter.md#op-setissuetext) | write |
|
|
1971
|
+
| GET | `/api/v1/newsletters/{newsletter_id}/issues/{issue_id}/versions` | [`g8.api.newsletter.listNewsletterIssueVersions`](newsletter.md#op-listnewsletterissueversions) | read |
|
|
1972
|
+
| POST | `/api/v1/newsletters/{newsletter_id}/issues/{issue_id}/versions/{version_num}/restore` | [`g8.api.newsletter.restoreNewsletterIssueVersion`](newsletter.md#op-restorenewsletterissueversion) | write |
|
|
1973
|
+
| GET | `/api/v1/newsletters/{newsletter_id}/list-syncs` | [`g8.api.newsletter.listNewsletterListSyncs`](newsletter.md#op-listnewsletterlistsyncs) | read |
|
|
1974
|
+
| POST | `/api/v1/newsletters/{newsletter_id}/list-syncs` | [`g8.api.newsletter.enableNewsletterListSync`](newsletter.md#op-enablenewsletterlistsync) | write |
|
|
1975
|
+
| DELETE | `/api/v1/newsletters/{newsletter_id}/list-syncs/{audience_list_id}` | [`g8.api.newsletter.disableNewsletterListSync`](newsletter.md#op-disablenewsletterlistsync) | destructive |
|
|
1976
|
+
| POST | `/api/v1/newsletters/{newsletter_id}/list-syncs/{audience_list_id}/run` | [`g8.api.newsletter.runNewsletterListSync`](newsletter.md#op-runnewsletterlistsync) | write |
|
|
1977
|
+
| POST | `/api/v1/newsletters/{newsletter_id}/pause` | [`g8.api.newsletter.pauseNewsletter`](newsletter.md#op-pausenewsletter) | write |
|
|
1978
|
+
| POST | `/api/v1/newsletters/{newsletter_id}/resume` | [`g8.api.newsletter.resumeNewsletter`](newsletter.md#op-resumenewsletter) | external |
|
|
1979
|
+
| GET | `/api/v1/newsletters/{newsletter_id}/settings` | [`g8.api.newsletter.getNewsletterSettings`](newsletter.md#op-getnewslettersettings) | read |
|
|
1980
|
+
| PUT | `/api/v1/newsletters/{newsletter_id}/settings` | [`g8.api.newsletter.updateNewsletterSettings`](newsletter.md#op-updatenewslettersettings) | write |
|
|
1981
|
+
| GET | `/api/v1/newsletters/{newsletter_id}/settings/domain-status` | [`g8.api.newsletter.newsletterDomainStatus`](newsletter.md#op-newsletterdomainstatus) | read |
|
|
1982
|
+
| POST | `/api/v1/newsletters/{newsletter_id}/settings/verify-domain` | [`g8.api.newsletter.verifyNewsletterDomain`](newsletter.md#op-verifynewsletterdomain) | external |
|
|
1983
|
+
| GET | `/api/v1/newsletters/{newsletter_id}/subscribers` | [`g8.api.newsletter.listSubscribers`](newsletter.md#op-listsubscribers) or `g8.newsletter.listSubscribers()` | read |
|
|
1984
|
+
| POST | `/api/v1/newsletters/{newsletter_id}/subscribers` | [`g8.api.newsletter.addSubscriber`](newsletter.md#op-addsubscriber) or `g8.newsletter.addSubscriber()` | external |
|
|
1985
|
+
| POST | `/api/v1/newsletters/{newsletter_id}/subscribers/import-audience` | [`g8.api.newsletter.importSubscribersFromAudience`](newsletter.md#op-importsubscribersfromaudience) | billable |
|
|
1986
|
+
| POST | `/api/v1/newsletters/{newsletter_id}/subscribers/verify` | [`g8.api.newsletter.verifyNewsletterSubscribers`](newsletter.md#op-verifynewslettersubscribers) | billable |
|
|
1987
|
+
| POST | `/api/v1/newsletters/{newsletter_id}/subscribers/verify/preview` | [`g8.api.newsletter.previewNewsletterSubscriberVerification`](newsletter.md#op-previewnewslettersubscriberverification) | read |
|
|
1988
|
+
| GET | `/api/v1/newsletters/{newsletter_id}/subscribers/verify/status` | [`g8.api.newsletter.getNewsletterSubscriberVerification`](newsletter.md#op-getnewslettersubscriberverification) | read |
|
|
1989
|
+
| DELETE | `/api/v1/newsletters/{newsletter_id}/subscribers/{subscriber_id}` | [`g8.api.newsletter.deleteSubscriber`](newsletter.md#op-deletesubscriber) | destructive |
|
|
1990
|
+
| PATCH | `/api/v1/newsletters/{newsletter_id}/subscribers/{subscriber_id}/unsubscribe` | [`g8.api.newsletter.unsubscribeSubscriber`](newsletter.md#op-unsubscribesubscriber) or `g8.newsletter.unsubscribe()` | external |
|
|
1991
|
+
| GET | `/api/v1/notes` | [`g8.api.notes.listNotesForRecord`](notes.md#op-listnotesforrecord) | read |
|
|
1992
|
+
| POST | `/api/v1/notes` | [`g8.api.notes.createRecordNote`](notes.md#op-createrecordnote) | write |
|
|
1993
|
+
| POST | `/api/v1/notes/batch` | [`g8.api.notes.listNotesForContacts`](notes.md#op-listnotesforcontacts) | read |
|
|
1994
|
+
| DELETE | `/api/v1/notes/replies/{reply_id}` | [`g8.api.notes.deleteNoteReply`](notes.md#op-deletenotereply) | destructive |
|
|
1995
|
+
| PUT | `/api/v1/notes/replies/{reply_id}` | [`g8.api.notes.updateNoteReply`](notes.md#op-updatenotereply) | write |
|
|
1996
|
+
| DELETE | `/api/v1/notes/{note_id}` | [`g8.api.notes.deleteNote`](notes.md#op-deletenote) or `g8.notes.delete()` | destructive |
|
|
1997
|
+
| PATCH | `/api/v1/notes/{note_id}` | [`g8.api.notes.updateNote`](notes.md#op-updatenote) or `g8.notes.update()` | write |
|
|
1998
|
+
| DELETE | `/api/v1/notes/{note_id}/records` | [`g8.api.notes.unlinkNoteRecord`](notes.md#op-unlinknoterecord) | destructive |
|
|
1999
|
+
| POST | `/api/v1/notes/{note_id}/records` | [`g8.api.notes.linkNoteRecord`](notes.md#op-linknoterecord) | write |
|
|
2000
|
+
| GET | `/api/v1/notes/{note_id}/replies` | [`g8.api.notes.listNoteReplies`](notes.md#op-listnotereplies) | read |
|
|
2001
|
+
| POST | `/api/v1/notes/{note_id}/replies` | [`g8.api.notes.createNoteReply`](notes.md#op-createnotereply) | write |
|
|
2002
|
+
| DELETE | `/api/v1/notes/{note_id}/resolve` | [`g8.api.notes.reopenNoteThread`](notes.md#op-reopennotethread) | destructive |
|
|
2003
|
+
| POST | `/api/v1/notes/{note_id}/resolve` | [`g8.api.notes.resolveNoteThread`](notes.md#op-resolvenotethread) | write |
|
|
2004
|
+
| DELETE | `/api/v1/notifications/by-entity` | [`g8.api.notifications.deleteNotificationsByEntity`](notifications.md#op-deletenotificationsbyentity) | destructive |
|
|
2005
|
+
| PUT | `/api/v1/notifications/by-entity/read` | [`g8.api.notifications.markNotificationsByEntityRead`](notifications.md#op-marknotificationsbyentityread) | write |
|
|
2006
|
+
| GET | `/api/v1/nurtures` | [`g8.api.sequences.listNurtures`](sequences.md#op-listnurtures) | read |
|
|
2007
|
+
| POST | `/api/v1/nurtures` | [`g8.api.sequences.createNurture`](sequences.md#op-createnurture) | write |
|
|
2008
|
+
| DELETE | `/api/v1/nurtures/{nurture_id}` | [`g8.api.sequences.deleteNurture`](sequences.md#op-deletenurture) | destructive |
|
|
2009
|
+
| GET | `/api/v1/nurtures/{nurture_id}` | [`g8.api.sequences.getNurture`](sequences.md#op-getnurture) | read |
|
|
2010
|
+
| PATCH | `/api/v1/nurtures/{nurture_id}` | [`g8.api.sequences.updateNurture`](sequences.md#op-updatenurture) | write |
|
|
2011
|
+
| POST | `/api/v1/nurtures/{nurture_id}/duplicate` | [`g8.api.sequences.duplicateNurture`](sequences.md#op-duplicatenurture) | write |
|
|
2012
|
+
| POST | `/api/v1/nurtures/{nurture_id}/launch` | [`g8.api.sequences.launchNurture`](sequences.md#op-launchnurture) | external |
|
|
2013
|
+
| POST | `/api/v1/nurtures/{nurture_id}/pause` | [`g8.api.sequences.pauseNurture`](sequences.md#op-pausenurture) | write |
|
|
2014
|
+
| POST | `/api/v1/nurtures/{nurture_id}/resume` | [`g8.api.sequences.resumeNurture`](sequences.md#op-resumenurture) | write |
|
|
2015
|
+
| GET | `/api/v1/objects` | [`g8.api.objects.listObjects`](objects.md#op-listobjects) or `g8.objects.list()` | read |
|
|
2016
|
+
| POST | `/api/v1/objects` | [`g8.api.objects.createObject`](objects.md#op-createobject) or `g8.objects.create()` | write |
|
|
2017
|
+
| DELETE | `/api/v1/objects/{object_slug}` | [`g8.api.objects.archiveObject`](objects.md#op-archiveobject) or `g8.objects.archive()` | destructive |
|
|
2018
|
+
| GET | `/api/v1/objects/{object_slug}` | [`g8.api.objects.getObject`](objects.md#op-getobject) or `g8.objects.get()` | read |
|
|
2019
|
+
| PATCH | `/api/v1/objects/{object_slug}` | [`g8.api.objects.updateObject`](objects.md#op-updateobject) or `g8.objects.update()` | write |
|
|
2020
|
+
| GET | `/api/v1/objects/{object_slug}/attributes` | [`g8.api.objects.listObjectAttributes`](objects.md#op-listobjectattributes) or `g8.objects.listAttributes()` | read |
|
|
2021
|
+
| POST | `/api/v1/objects/{object_slug}/attributes` | [`g8.api.objects.createAttribute`](objects.md#op-createattribute) or `g8.objects.createAttribute()` | write |
|
|
2022
|
+
| DELETE | `/api/v1/objects/{object_slug}/attributes/{attr_slug}` | [`g8.api.objects.archiveAttribute`](objects.md#op-archiveattribute) or `g8.objects.archiveAttribute()` | destructive |
|
|
2023
|
+
| PATCH | `/api/v1/objects/{object_slug}/attributes/{attr_slug}` | [`g8.api.objects.updateAttribute`](objects.md#op-updateattribute) or `g8.objects.updateAttribute()` | write |
|
|
2024
|
+
| GET | `/api/v1/objects/{object_slug}/records` | [`g8.api.objects.listObjectRecords`](objects.md#op-listobjectrecords) or `g8.objects.listRecords()` | read |
|
|
2025
|
+
| POST | `/api/v1/objects/{object_slug}/records` | [`g8.api.objects.createObjectRecord`](objects.md#op-createobjectrecord) or `g8.objects.createRecord()` | write |
|
|
2026
|
+
| POST | `/api/v1/objects/{object_slug}/records/upsert` | [`g8.api.objects.upsertObjectRecord`](objects.md#op-upsertobjectrecord) or `g8.objects.upsertRecord()` | write |
|
|
2027
|
+
| DELETE | `/api/v1/objects/{object_slug}/records/{record_id}` | [`g8.api.objects.archiveObjectRecord`](objects.md#op-archiveobjectrecord) or `g8.objects.archiveRecord()` | destructive |
|
|
2028
|
+
| GET | `/api/v1/objects/{object_slug}/records/{record_id}` | [`g8.api.objects.getObjectRecord`](objects.md#op-getobjectrecord) or `g8.objects.getRecord()` | read |
|
|
2029
|
+
| PATCH | `/api/v1/objects/{object_slug}/records/{record_id}` | [`g8.api.objects.updateObjectRecord`](objects.md#op-updateobjectrecord) or `g8.objects.updateRecord()` | write |
|
|
2030
|
+
| GET | `/api/v1/objects/{object_slug}/records/{record_id}/changes` | [`g8.api.objects.getObjectRecordChanges`](objects.md#op-getobjectrecordchanges) or `g8.objects.changes()` | read |
|
|
2031
|
+
| GET | `/api/v1/objects/{object_slug}/records/{record_id}/history` | [`g8.api.objects.getObjectRecordHistory`](objects.md#op-getobjectrecordhistory) or `g8.objects.history()` | read |
|
|
2032
|
+
| POST | `/api/v1/objects/{object_slug}/records/{record_id}/restore` | [`g8.api.objects.restoreObjectRecord`](objects.md#op-restoreobjectrecord) or `g8.objects.restoreRecord()` | write |
|
|
2033
|
+
| POST | `/api/v1/opensearch/aggregate` | [`g8.api.openSearch.opensearchAggregate`](openSearch.md#op-opensearchaggregate) | write |
|
|
2034
|
+
| POST | `/api/v1/opensearch/count` | [`g8.api.openSearch.opensearchCount`](openSearch.md#op-opensearchcount) | write |
|
|
2035
|
+
| POST | `/api/v1/opensearch/resolve` | [`g8.api.openSearch.opensearchResolve`](openSearch.md#op-opensearchresolve) | write |
|
|
2036
|
+
| POST | `/api/v1/opensearch/search` | [`g8.api.openSearch.opensearchSearch`](openSearch.md#op-opensearchsearch) | write |
|
|
2037
|
+
| GET | `/api/v1/ops` | [`g8.api.ops.opsIndex`](ops.md#op-opsindex) | read |
|
|
2038
|
+
| GET | `/api/v1/ops/orgs/{org_id}/linkedin/actions` | [`g8.api.ops.listLinkedinActions`](ops.md#op-listlinkedinactions) | read |
|
|
2039
|
+
| GET | `/api/v1/ops/orgs/{org_id}/linkedin/actions/summary` | [`g8.api.ops.summarizeLinkedinActions`](ops.md#op-summarizelinkedinactions) | read |
|
|
2040
|
+
| GET | `/api/v1/ops/orgs/{org_id}/linkedin/sequence-bindings` | [`g8.api.ops.getSequenceBindings`](ops.md#op-getsequencebindings) | read |
|
|
2041
|
+
| GET | `/api/v1/ops/orgs/{org_id}/linkedin/webhook-events` | [`g8.api.ops.summarizeWebhookEvents`](ops.md#op-summarizewebhookevents) | read |
|
|
2042
|
+
| GET | `/api/v1/org-videos` | [`g8.api.orgVideos.listOrgVideos`](orgVideos.md#op-listorgvideos) | read |
|
|
2043
|
+
| POST | `/api/v1/org-videos/generate` | [`g8.api.orgVideos.generateOrgVideo`](orgVideos.md#op-generateorgvideo) | billable |
|
|
2044
|
+
| POST | `/api/v1/org-videos/upload` | [`g8.api.orgVideos.uploadOrgVideo`](orgVideos.md#op-uploadorgvideo) | write |
|
|
2045
|
+
| DELETE | `/api/v1/org-videos/{video_id}` | [`g8.api.orgVideos.deleteOrgVideo`](orgVideos.md#op-deleteorgvideo) | destructive |
|
|
2046
|
+
| GET | `/api/v1/org-videos/{video_id}` | [`g8.api.orgVideos.getOrgVideo`](orgVideos.md#op-getorgvideo) | read |
|
|
2047
|
+
| PATCH | `/api/v1/org-videos/{video_id}` | [`g8.api.orgVideos.updateOrgVideo`](orgVideos.md#op-updateorgvideo) | write |
|
|
2048
|
+
| GET | `/api/v1/org/ai-connections` | [`g8.api.orgGovernance.listAiConnections`](orgGovernance.md#op-listaiconnections) | read |
|
|
2049
|
+
| GET | `/api/v1/org/ai-connections/config` | [`g8.api.orgGovernance.getAiConnectionsConfig`](orgGovernance.md#op-getaiconnectionsconfig) | read |
|
|
2050
|
+
| PUT | `/api/v1/org/ai-connections/config` | [`g8.api.orgGovernance.updateAiConnectionsConfig`](orgGovernance.md#op-updateaiconnectionsconfig) | write |
|
|
2051
|
+
| DELETE | `/api/v1/org/ai-connections/{user_id}/activity` | [`g8.api.orgGovernance.deleteAiConnectionActivity`](orgGovernance.md#op-deleteaiconnectionactivity) | destructive |
|
|
2052
|
+
| DELETE | `/api/v1/org/ai-connections/{user_id}/blocks` | [`g8.api.orgGovernance.resumeAiConnection`](orgGovernance.md#op-resumeaiconnection) | destructive |
|
|
2053
|
+
| POST | `/api/v1/org/ai-connections/{user_id}/blocks` | [`g8.api.orgGovernance.blockAiConnection`](orgGovernance.md#op-blockaiconnection) | write |
|
|
2054
|
+
| GET | `/api/v1/org/ai-connections/{user_id}/calls` | [`g8.api.orgGovernance.listAiConnectionCalls`](orgGovernance.md#op-listaiconnectioncalls) | read |
|
|
2055
|
+
| GET | `/api/v1/org/ai-connections/{user_id}/summary` | [`g8.api.orgGovernance.getAiConnectionSummary`](orgGovernance.md#op-getaiconnectionsummary) | read |
|
|
2056
|
+
| GET | `/api/v1/org/brand-snapshot` | [`g8.api.studioDocuments.getBrandSnapshot`](studioDocuments.md#op-getbrandsnapshot) | read |
|
|
2057
|
+
| POST | `/api/v1/org/brand-snapshot/refresh` | [`g8.api.studioDocuments.refreshBrandSnapshot`](studioDocuments.md#op-refreshbrandsnapshot) | billable |
|
|
2058
|
+
| GET | `/api/v1/org/content-sources` | [`g8.api.organizationSettings.getContentSources`](organizationSettings.md#op-getcontentsources) | read |
|
|
2059
|
+
| PUT | `/api/v1/org/content-sources` | [`g8.api.organizationSettings.updateContentSources`](organizationSettings.md#op-updatecontentsources) | write |
|
|
2060
|
+
| GET | `/api/v1/org/infrastructure` | [`g8.api.orgGovernance.getInfrastructureProfile`](orgGovernance.md#op-getinfrastructureprofile) | read |
|
|
2061
|
+
| PUT | `/api/v1/org/infrastructure` | [`g8.api.orgGovernance.updateInfrastructureProfile`](orgGovernance.md#op-updateinfrastructureprofile) | write |
|
|
2062
|
+
| GET | `/api/v1/org/infrastructure/security-roles` | [`g8.api.orgGovernance.listSecurityRoles`](orgGovernance.md#op-listsecurityroles) | read |
|
|
2063
|
+
| DELETE | `/api/v1/org/infrastructure/security-roles/{role_id}` | [`g8.api.orgGovernance.unassignSecurityRole`](orgGovernance.md#op-unassignsecurityrole) | destructive |
|
|
2064
|
+
| PUT | `/api/v1/org/infrastructure/security-roles/{role_id}` | [`g8.api.orgGovernance.assignSecurityRole`](orgGovernance.md#op-assignsecurityrole) | write |
|
|
2065
|
+
| GET | `/api/v1/org/rep-limits` | [`g8.api.orgGovernance.listRepLimits`](orgGovernance.md#op-listreplimits) | read |
|
|
2066
|
+
| PUT | `/api/v1/org/rep-limits/{user_id}` | [`g8.api.orgGovernance.setRepLimitsOverride`](orgGovernance.md#op-setreplimitsoverride) | write |
|
|
2067
|
+
| GET | `/api/v1/org/settings` | [`g8.api.organizationSettings.getOrgSettings`](organizationSettings.md#op-getorgsettings) | read |
|
|
2068
|
+
| PUT | `/api/v1/org/settings` | [`g8.api.organizationSettings.updateOrgSettings`](organizationSettings.md#op-updateorgsettings) | write |
|
|
2069
|
+
| GET | `/api/v1/org/settings/campaign-generation` | [`g8.api.organizationSettings.getCampaignGenerationSettings`](organizationSettings.md#op-getcampaigngenerationsettings) | read |
|
|
2070
|
+
| PUT | `/api/v1/org/settings/campaign-generation` | [`g8.api.organizationSettings.updateCampaignGenerationSettings`](organizationSettings.md#op-updatecampaigngenerationsettings) | write |
|
|
2071
|
+
| GET | `/api/v1/org/settings/compliance` | [`g8.api.organizationSettings.getComplianceSettings`](organizationSettings.md#op-getcompliancesettings) | read |
|
|
2072
|
+
| PUT | `/api/v1/org/settings/compliance` | [`g8.api.organizationSettings.updateComplianceSettings`](organizationSettings.md#op-updatecompliancesettings) | write |
|
|
2073
|
+
| GET | `/api/v1/org/settings/cost` | [`g8.api.settings.getCostSettings`](settings.md#op-getcostsettings) | read |
|
|
2074
|
+
| PUT | `/api/v1/org/settings/cost` | [`g8.api.settings.updateCostSettings`](settings.md#op-updatecostsettings) | write |
|
|
2075
|
+
| GET | `/api/v1/org/settings/deliverability-protection` | [`g8.api.settings.getDeliverabilityProtection`](settings.md#op-getdeliverabilityprotection) | read |
|
|
2076
|
+
| PUT | `/api/v1/org/settings/deliverability-protection` | [`g8.api.settings.updateDeliverabilityProtection`](settings.md#op-updatedeliverabilityprotection) | write |
|
|
2077
|
+
| GET | `/api/v1/org/settings/departments` | [`g8.api.settings.getDepartments`](settings.md#op-getdepartments) | read |
|
|
2078
|
+
| PUT | `/api/v1/org/settings/departments` | [`g8.api.settings.updateDepartments`](settings.md#op-updatedepartments) | write |
|
|
2079
|
+
| POST | `/api/v1/org/settings/departments/seed-defaults` | [`g8.api.settings.seedDepartmentDefaults`](settings.md#op-seeddepartmentdefaults) | destructive |
|
|
2080
|
+
| GET | `/api/v1/org/settings/docs` | [`g8.api.organizationSettings.getDocSettings`](organizationSettings.md#op-getdocsettings) | read |
|
|
2081
|
+
| GET | `/api/v1/org/settings/docs/folders/{scope}` | [`g8.api.organizationSettings.getDocFolderTemplate`](organizationSettings.md#op-getdocfoldertemplate) | read |
|
|
2082
|
+
| PUT | `/api/v1/org/settings/docs/folders/{scope}` | [`g8.api.organizationSettings.updateDocFolderTemplate`](organizationSettings.md#op-updatedocfoldertemplate) | write |
|
|
2083
|
+
| GET | `/api/v1/org/settings/docs/meetings` | [`g8.api.organizationSettings.getMeetingExtractionSettings`](organizationSettings.md#op-getmeetingextractionsettings) | read |
|
|
2084
|
+
| PUT | `/api/v1/org/settings/docs/meetings` | [`g8.api.organizationSettings.updateMeetingExtractionSettings`](organizationSettings.md#op-updatemeetingextractionsettings) | write |
|
|
2085
|
+
| PUT | `/api/v1/org/settings/docs/{scope}` | [`g8.api.organizationSettings.updateDocSettings`](organizationSettings.md#op-updatedocsettings) | write |
|
|
2086
|
+
| GET | `/api/v1/org/settings/document-priority` | [`g8.api.organizationSettings.getDocumentPrioritySettings`](organizationSettings.md#op-getdocumentprioritysettings) | read |
|
|
2087
|
+
| PUT | `/api/v1/org/settings/document-priority` | [`g8.api.organizationSettings.updateDocumentPrioritySettings`](organizationSettings.md#op-updatedocumentprioritysettings) | write |
|
|
2088
|
+
| GET | `/api/v1/org/settings/lead-qualification` | [`g8.api.organizationSettings.getLeadQualificationSettings`](organizationSettings.md#op-getleadqualificationsettings) | read |
|
|
2089
|
+
| PUT | `/api/v1/org/settings/lead-qualification` | [`g8.api.organizationSettings.updateLeadQualificationSettings`](organizationSettings.md#op-updateleadqualificationsettings) | write |
|
|
2090
|
+
| POST | `/api/v1/org/settings/lead-qualification/backfill` | [`g8.api.organizationSettings.triggerLeadQualificationBackfill`](organizationSettings.md#op-triggerleadqualificationbackfill) | write |
|
|
2091
|
+
| GET | `/api/v1/org/settings/lead-qualification/backfill-status` | [`g8.api.organizationSettings.getLeadQualificationBackfillStatus`](organizationSettings.md#op-getleadqualificationbackfillstatus) | read |
|
|
2092
|
+
| GET | `/api/v1/org/settings/outbound-tracking` | [`g8.api.settings.getOutboundTracking`](settings.md#op-getoutboundtracking) | read |
|
|
2093
|
+
| PUT | `/api/v1/org/settings/outbound-tracking` | [`g8.api.settings.updateOutboundTracking`](settings.md#op-updateoutboundtracking) | write |
|
|
2094
|
+
| GET | `/api/v1/org/settings/tasks` | [`g8.api.organizationSettings.getTaskSettings`](organizationSettings.md#op-gettasksettings) | read |
|
|
2095
|
+
| PUT | `/api/v1/org/settings/tasks` | [`g8.api.organizationSettings.updateTaskSettings`](organizationSettings.md#op-updatetasksettings) | write |
|
|
2096
|
+
| DELETE | `/api/v1/org/sso` | [`g8.api.settings.deleteSsoConfig`](settings.md#op-deletessoconfig) | destructive |
|
|
2097
|
+
| GET | `/api/v1/org/sso` | [`g8.api.settings.getSsoConfig`](settings.md#op-getssoconfig) | read |
|
|
2098
|
+
| POST | `/api/v1/org/sso/activate` | [`g8.api.settings.activateSso`](settings.md#op-activatesso) | write |
|
|
2099
|
+
| POST | `/api/v1/org/sso/deactivate` | [`g8.api.settings.deactivateSso`](settings.md#op-deactivatesso) | destructive |
|
|
2100
|
+
| PUT | `/api/v1/org/sso/enforcement` | [`g8.api.settings.updateSsoEnforcement`](settings.md#op-updatessoenforcement) | destructive |
|
|
2101
|
+
| GET | `/api/v1/org/sso/metadata` | [`g8.api.settings.getSsoMetadata`](settings.md#op-getssometadata) | read |
|
|
2102
|
+
| PUT | `/api/v1/org/sso/oidc` | [`g8.api.settings.configureOidcSso`](settings.md#op-configureoidcsso) | write |
|
|
2103
|
+
| PUT | `/api/v1/org/sso/saml` | [`g8.api.settings.configureSamlSso`](settings.md#op-configuresamlsso) | write |
|
|
2104
|
+
| POST | `/api/v1/org/sso/sync` | [`g8.api.settings.syncSsoConfig`](settings.md#op-syncssoconfig) | external |
|
|
2105
|
+
| GET | `/api/v1/org/suppression-settings` | [`g8.api.orgGovernance.getSuppressionSettings`](orgGovernance.md#op-getsuppressionsettings) | read |
|
|
2106
|
+
| PUT | `/api/v1/org/suppression-settings` | [`g8.api.orgGovernance.updateSuppressionSettings`](orgGovernance.md#op-updatesuppressionsettings) | write |
|
|
2107
|
+
| GET | `/api/v1/personas` | [`g8.api.gtmContext.listPersonas`](gtmContext.md#op-listpersonas) or `g8.studio.personas()` | read |
|
|
2108
|
+
| POST | `/api/v1/personas` | [`g8.api.gtmContext.createPersona`](gtmContext.md#op-createpersona) or `g8.studio.createPersona()` | write |
|
|
2109
|
+
| POST | `/api/v1/personas/from-global-doc` | [`g8.api.gtmLibrary.fillPersonasFromGlobalDoc`](gtmLibrary.md#op-fillpersonasfromglobaldoc) | write |
|
|
2110
|
+
| POST | `/api/v1/personas/generate` | [`g8.api.gtmLibrary.generatePersonas`](gtmLibrary.md#op-generatepersonas) | billable |
|
|
2111
|
+
| DELETE | `/api/v1/personas/{persona_id}` | [`g8.api.gtmLibrary.deletePersona`](gtmLibrary.md#op-deletepersona) | destructive |
|
|
2112
|
+
| GET | `/api/v1/personas/{persona_id}` | [`g8.api.gtmLibrary.getPersona`](gtmLibrary.md#op-getpersona) | read |
|
|
2113
|
+
| PATCH | `/api/v1/personas/{persona_id}` | [`g8.api.gtmContext.updatePersona`](gtmContext.md#op-updatepersona) or `g8.studio.updatePersona()` | write |
|
|
2114
|
+
| POST | `/api/v1/personas/{persona_id}/archive` | [`g8.api.gtmContext.archivePersona`](gtmContext.md#op-archivepersona) or `g8.studio.archivePersona()` | destructive |
|
|
2115
|
+
| POST | `/api/v1/personas/{persona_id}/pin` | [`g8.api.gtmLibrary.pinPersona`](gtmLibrary.md#op-pinpersona) | write |
|
|
2116
|
+
| POST | `/api/v1/personas/{persona_id}/unpin` | [`g8.api.gtmLibrary.unpinPersona`](gtmLibrary.md#op-unpinpersona) | write |
|
|
2117
|
+
| POST | `/api/v1/phone-numbers/a2p/inputs` | [`g8.api.phoneNumbers.saveA2pInputs`](phoneNumbers.md#op-savea2pinputs) | write |
|
|
2118
|
+
| POST | `/api/v1/phone-numbers/a2p/reconcile` | [`g8.api.phoneNumbers.reconcileA2pRegistration`](phoneNumbers.md#op-reconcilea2pregistration) | write |
|
|
2119
|
+
| POST | `/api/v1/phone-numbers/a2p/register` | [`g8.api.phoneNumbers.startA2pRegistration`](phoneNumbers.md#op-starta2pregistration) | external |
|
|
2120
|
+
| GET | `/api/v1/phone-numbers/a2p/status` | [`g8.api.phoneNumbers.getPhoneA2pStatus`](phoneNumbers.md#op-getphonea2pstatus) | read |
|
|
2121
|
+
| POST | `/api/v1/phone-numbers/purchase` | [`g8.api.phoneNumbers.purchasePhoneNumber`](phoneNumbers.md#op-purchasephonenumber) | billable |
|
|
2122
|
+
| POST | `/api/v1/phone-numbers/release` | [`g8.api.phoneNumbers.releasePhoneNumber`](phoneNumbers.md#op-releasephonenumber) | destructive |
|
|
2123
|
+
| POST | `/api/v1/phone-numbers/search` | [`g8.api.phoneNumbers.searchAvailablePhoneNumbers`](phoneNumbers.md#op-searchavailablephonenumbers) | read |
|
|
2124
|
+
| PATCH | `/api/v1/phone-numbers/update-assignee` | [`g8.api.phoneNumbers.updatePhoneAssignee`](phoneNumbers.md#op-updatephoneassignee) | write |
|
|
2125
|
+
| PATCH | `/api/v1/phone-numbers/update-capabilities` | [`g8.api.phoneNumbers.updatePhoneCapabilities`](phoneNumbers.md#op-updatephonecapabilities) | write |
|
|
2126
|
+
| GET | `/api/v1/pipelines` | [`g8.api.cliPipelines.listPipelines`](cliPipelines.md#op-listpipelines) or `g8.pipelines.list()` | read |
|
|
2127
|
+
| POST | `/api/v1/pipelines` | [`g8.api.cliPipelines.createPipeline`](cliPipelines.md#op-createpipeline) or `g8.pipelines.create()` | write |
|
|
2128
|
+
| GET | `/api/v1/pipelines/evidence-library` | [`g8.api.cliPipelines.listStageEvidenceLibrary`](cliPipelines.md#op-liststageevidencelibrary) or `g8.pipelines.evidenceLibrary()` | read |
|
|
2129
|
+
| POST | `/api/v1/pipelines/from-suggestion` | [`g8.api.cliPipelines.createPipelineFromSuggestion`](cliPipelines.md#op-createpipelinefromsuggestion) or `g8.pipelines.fromSuggestion()` | write |
|
|
2130
|
+
| POST | `/api/v1/pipelines/suggest` | [`g8.api.cliPipelines.suggestPipeline`](cliPipelines.md#op-suggestpipeline) or `g8.pipelines.suggest()` | billable |
|
|
2131
|
+
| DELETE | `/api/v1/pipelines/{pipeline_id}` | [`g8.api.cliPipelines.deletePipeline`](cliPipelines.md#op-deletepipeline) or `g8.pipelines.delete()` | destructive |
|
|
2132
|
+
| GET | `/api/v1/pipelines/{pipeline_id}` | [`g8.api.cliPipelines.getPipeline`](cliPipelines.md#op-getpipeline) or `g8.pipelines.get()` | read |
|
|
2133
|
+
| PUT | `/api/v1/pipelines/{pipeline_id}` | [`g8.api.cliPipelines.updatePipeline`](cliPipelines.md#op-updatepipeline) or `g8.pipelines.update()` | write |
|
|
2134
|
+
| POST | `/api/v1/pipelines/{pipeline_id}/stages` | [`g8.api.cliPipelines.createStage`](cliPipelines.md#op-createstage) or `g8.pipelines.createStage()` | write |
|
|
2135
|
+
| PUT | `/api/v1/pipelines/{pipeline_id}/stages/reorder` | [`g8.api.cliPipelines.reorderStages`](cliPipelines.md#op-reorderstages) or `g8.pipelines.reorderStages()` | write |
|
|
2136
|
+
| DELETE | `/api/v1/pipelines/{pipeline_id}/stages/{stage_id}` | [`g8.api.cliPipelines.deleteStage`](cliPipelines.md#op-deletestage) or `g8.pipelines.deleteStage()` | destructive |
|
|
2137
|
+
| PUT | `/api/v1/pipelines/{pipeline_id}/stages/{stage_id}` | [`g8.api.cliPipelines.updateStage`](cliPipelines.md#op-updatestage) or `g8.pipelines.updateStage()` | write |
|
|
2138
|
+
| GET | `/api/v1/placement/domains/stats` | [`g8.api.mailboxes.getPlacementDomainStats`](mailboxes.md#op-getplacementdomainstats) | read |
|
|
2139
|
+
| GET | `/api/v1/placement/domains/{domain_id}/summary` | [`g8.api.mailboxes.getPlacementDomainSummary`](mailboxes.md#op-getplacementdomainsummary) | read |
|
|
2140
|
+
| GET | `/api/v1/placement/scheduled` | [`g8.api.mailboxes.listScheduledPlacementTests`](mailboxes.md#op-listscheduledplacementtests) | read |
|
|
2141
|
+
| DELETE | `/api/v1/placement/scheduled/{schedule_id}` | [`g8.api.mailboxes.deleteScheduledPlacementTest`](mailboxes.md#op-deletescheduledplacementtest) | destructive |
|
|
2142
|
+
| GET | `/api/v1/placement/scheduled/{schedule_id}` | [`g8.api.mailboxes.getScheduledPlacementTest`](mailboxes.md#op-getscheduledplacementtest) | read |
|
|
2143
|
+
| POST | `/api/v1/placement/scheduled/{schedule_id}/pause` | [`g8.api.mailboxes.pauseScheduledPlacementTest`](mailboxes.md#op-pausescheduledplacementtest) | write |
|
|
2144
|
+
| POST | `/api/v1/placement/scheduled/{schedule_id}/resume` | [`g8.api.mailboxes.resumeScheduledPlacementTest`](mailboxes.md#op-resumescheduledplacementtest) | write |
|
|
2145
|
+
| GET | `/api/v1/placement/tests` | [`g8.api.mailboxes.listPlacementTests`](mailboxes.md#op-listplacementtests) | read |
|
|
2146
|
+
| POST | `/api/v1/placement/tests` | [`g8.api.mailboxes.createPlacementTest`](mailboxes.md#op-createplacementtest) | billable |
|
|
2147
|
+
| POST | `/api/v1/placement/tests/estimate` | [`g8.api.mailboxes.estimatePlacementTestCost`](mailboxes.md#op-estimateplacementtestcost) | read |
|
|
2148
|
+
| GET | `/api/v1/placement/tests/{test_id}` | [`g8.api.mailboxes.getPlacementTest`](mailboxes.md#op-getplacementtest) | read |
|
|
2149
|
+
| POST | `/api/v1/profile/avatar` | [`g8.api.profile.uploadProfileAvatar`](profile.md#op-uploadprofileavatar) | write |
|
|
2150
|
+
| GET | `/api/v1/profile/deal-automations` | [`g8.api.profile.getDealAutomations`](profile.md#op-getdealautomations) | read |
|
|
2151
|
+
| PUT | `/api/v1/profile/deal-automations` | [`g8.api.profile.updateDealAutomations`](profile.md#op-updatedealautomations) | write |
|
|
2152
|
+
| GET | `/api/v1/profile/deal-automations/pipeline-hints` | [`g8.api.profile.getPipelineDealHints`](profile.md#op-getpipelinedealhints) | read |
|
|
2153
|
+
| POST | `/api/v1/profile/deal-automations/sync-now` | [`g8.api.profile.syncMyCalendarNow`](profile.md#op-syncmycalendarnow) | external |
|
|
2154
|
+
| GET | `/api/v1/profile/mcp/sessions` | [`g8.api.profile.listMcpSessions`](profile.md#op-listmcpsessions) | read |
|
|
2155
|
+
| DELETE | `/api/v1/profile/mcp/sessions/{session_id}` | [`g8.api.profile.revokeMcpSession`](profile.md#op-revokemcpsession) | destructive |
|
|
2156
|
+
| GET | `/api/v1/profile/mcp/status` | [`g8.api.profile.getMcpConnectionStatus`](profile.md#op-getmcpconnectionstatus) | read |
|
|
2157
|
+
| GET | `/api/v1/profile/mcp/tools` | [`g8.api.profile.getAvailableMcpTools`](profile.md#op-getavailablemcptools) | read |
|
|
2158
|
+
| GET | `/api/v1/profile/mcp/usage` | [`g8.api.profile.getMcpUsageStats`](profile.md#op-getmcpusagestats) | read |
|
|
2159
|
+
| GET | `/api/v1/profile/notification-preferences` | [`g8.api.profile.getNotificationPreferences`](profile.md#op-getnotificationpreferences) | read |
|
|
2160
|
+
| PUT | `/api/v1/profile/notification-preferences` | [`g8.api.profile.updateNotificationPreference`](profile.md#op-updatenotificationpreference) | write |
|
|
2161
|
+
| GET | `/api/v1/profile/preferences` | [`g8.api.profile.getPreferences`](profile.md#op-getpreferences) | read |
|
|
2162
|
+
| PUT | `/api/v1/profile/preferences` | [`g8.api.profile.updatePreferences`](profile.md#op-updatepreferences) | write |
|
|
2163
|
+
| GET | `/api/v1/programmatic-campaigns` | [`g8.api.programmaticPages.listProgrammaticCampaigns`](programmaticPages.md#op-listprogrammaticcampaigns) | read |
|
|
2164
|
+
| POST | `/api/v1/programmatic-campaigns` | [`g8.api.programmaticPages.createProgrammaticCampaign`](programmaticPages.md#op-createprogrammaticcampaign) | write |
|
|
2165
|
+
| DELETE | `/api/v1/programmatic-campaigns/{campaign_id}` | [`g8.api.programmaticPages.deleteProgrammaticCampaign`](programmaticPages.md#op-deleteprogrammaticcampaign) | destructive |
|
|
2166
|
+
| GET | `/api/v1/programmatic-campaigns/{campaign_id}` | [`g8.api.programmaticPages.getProgrammaticCampaign`](programmaticPages.md#op-getprogrammaticcampaign) | read |
|
|
2167
|
+
| PATCH | `/api/v1/programmatic-campaigns/{campaign_id}` | [`g8.api.programmaticPages.updateProgrammaticCampaign`](programmaticPages.md#op-updateprogrammaticcampaign) | write |
|
|
2168
|
+
| POST | `/api/v1/programmatic-campaigns/{campaign_id}/generate` | [`g8.api.programmaticPages.startProgrammaticGeneration`](programmaticPages.md#op-startprogrammaticgeneration) | write |
|
|
2169
|
+
| POST | `/api/v1/programmatic-campaigns/{campaign_id}/imports/sitemap` | [`g8.api.programmaticPages.importProgrammaticSitemap`](programmaticPages.md#op-importprogrammaticsitemap) | write |
|
|
2170
|
+
| GET | `/api/v1/programmatic-campaigns/{campaign_id}/pages` | [`g8.api.programmaticPages.listProgrammaticGeneratedPages`](programmaticPages.md#op-listprogrammaticgeneratedpages) | read |
|
|
2171
|
+
| POST | `/api/v1/programmatic-campaigns/{campaign_id}/pages/actions` | [`g8.api.programmaticPages.runProgrammaticBulkPageAction`](programmaticPages.md#op-runprogrammaticbulkpageaction) | external |
|
|
2172
|
+
| POST | `/api/v1/programmatic-campaigns/{campaign_id}/pages/{page_id}/actions` | [`g8.api.programmaticPages.runProgrammaticPageAction`](programmaticPages.md#op-runprogrammaticpageaction) | external |
|
|
2173
|
+
| POST | `/api/v1/programmatic-campaigns/{campaign_id}/preview` | [`g8.api.programmaticPages.previewProgrammaticPage`](programmaticPages.md#op-previewprogrammaticpage) | write |
|
|
2174
|
+
| GET | `/api/v1/programmatic-campaigns/{campaign_id}/status` | [`g8.api.programmaticPages.getProgrammaticGenerationStatus`](programmaticPages.md#op-getprogrammaticgenerationstatus) | read |
|
|
2175
|
+
| GET | `/api/v1/programmatic-campaigns/{campaign_id}/variables` | [`g8.api.programmaticPages.getProgrammaticCampaignVariables`](programmaticPages.md#op-getprogrammaticcampaignvariables) | read |
|
|
2176
|
+
| GET | `/api/v1/programmatic-campaigns/{campaign_id}/workspace` | [`g8.api.programmaticPages.getProgrammaticWorkspace`](programmaticPages.md#op-getprogrammaticworkspace) | read |
|
|
2177
|
+
| PATCH | `/api/v1/programmatic-campaigns/{campaign_id}/workspace` | [`g8.api.programmaticPages.updateProgrammaticWorkspace`](programmaticPages.md#op-updateprogrammaticworkspace) | write |
|
|
2178
|
+
| GET | `/api/v1/provider-domains` | [`g8.api.providerDomains.listProviderDomains`](providerDomains.md#op-listproviderdomains) | read |
|
|
2179
|
+
| POST | `/api/v1/provider-domains/add-external` | [`g8.api.providerDomains.addExternalDomains`](providerDomains.md#op-addexternaldomains) | billable |
|
|
2180
|
+
| POST | `/api/v1/provider-domains/cancel-transfer` | [`g8.api.providerDomains.cancelDomainTransfer`](providerDomains.md#op-canceldomaintransfer) | destructive |
|
|
2181
|
+
| POST | `/api/v1/provider-domains/check-availability` | [`g8.api.providerDomains.checkDomainAvailability`](providerDomains.md#op-checkdomainavailability) | billable |
|
|
2182
|
+
| POST | `/api/v1/provider-domains/check-external-availability` | [`g8.api.providerDomains.checkExternalAvailability`](providerDomains.md#op-checkexternalavailability) | read |
|
|
2183
|
+
| POST | `/api/v1/provider-domains/check-transfer-availability` | [`g8.api.providerDomains.checkTransferAvailability`](providerDomains.md#op-checktransferavailability) | read |
|
|
2184
|
+
| POST | `/api/v1/provider-domains/checkout-purchase` | [`g8.api.providerDomains.checkoutPurchaseDomains`](providerDomains.md#op-checkoutpurchasedomains) | billable |
|
|
2185
|
+
| POST | `/api/v1/provider-domains/checkout-transfer` | [`g8.api.providerDomains.checkoutTransferDomain`](providerDomains.md#op-checkouttransferdomain) | billable |
|
|
2186
|
+
| POST | `/api/v1/provider-domains/generate-domains` | [`g8.api.providerDomains.generateDomainNames`](providerDomains.md#op-generatedomainnames) | read |
|
|
2187
|
+
| GET | `/api/v1/provider-domains/pricing` | [`g8.api.providerDomains.getSendingPricing`](providerDomains.md#op-getsendingpricing) | read |
|
|
2188
|
+
| GET | `/api/v1/provider-domains/stats` | [`g8.api.providerDomains.getSendingDomainStats`](providerDomains.md#op-getsendingdomainstats) | read |
|
|
2189
|
+
| GET | `/api/v1/provider-domains/stats/mailboxes/{stat_key}` | [`g8.api.providerDomains.listMailboxesForStat`](providerDomains.md#op-listmailboxesforstat) | read |
|
|
2190
|
+
| POST | `/api/v1/provider-domains/{domain_id}/auto-warmup` | [`g8.api.providerDomains.setAutoWarmup`](providerDomains.md#op-setautowarmup) | billable |
|
|
2191
|
+
| POST | `/api/v1/provider-domains/{domain_id}/check-mailbox-status` | [`g8.api.providerDomains.checkMailboxStatus`](providerDomains.md#op-checkmailboxstatus) | write |
|
|
2192
|
+
| POST | `/api/v1/provider-domains/{domain_id}/check-propagation` | [`g8.api.providerDomains.checkDomainPropagation`](providerDomains.md#op-checkdomainpropagation) | billable |
|
|
2193
|
+
| POST | `/api/v1/provider-domains/{domain_id}/checkout-mailboxes` | [`g8.api.providerDomains.checkoutPurchaseMailboxes`](providerDomains.md#op-checkoutpurchasemailboxes) | billable |
|
|
2194
|
+
| POST | `/api/v1/provider-domains/{domain_id}/connect-provider` | [`g8.api.providerDomains.connectProvider`](providerDomains.md#op-connectprovider) | billable |
|
|
2195
|
+
| POST | `/api/v1/provider-domains/{domain_id}/delete-mailbox` | [`g8.api.providerDomains.deleteDomainMailbox`](providerDomains.md#op-deletedomainmailbox) | destructive |
|
|
2196
|
+
| POST | `/api/v1/provider-domains/{domain_id}/dns` | [`g8.api.providerDomains.setDnsRecords`](providerDomains.md#op-setdnsrecords) | billable |
|
|
2197
|
+
| POST | `/api/v1/provider-domains/{domain_id}/external-info` | [`g8.api.providerDomains.getExternalDomainInfo`](providerDomains.md#op-getexternaldomaininfo) | read |
|
|
2198
|
+
| DELETE | `/api/v1/provider-domains/{domain_id}/forwarding` | [`g8.api.providerDomains.deleteDomainForwarding`](providerDomains.md#op-deletedomainforwarding) | destructive |
|
|
2199
|
+
| POST | `/api/v1/provider-domains/{domain_id}/forwarding` | [`g8.api.providerDomains.setDomainForwarding`](providerDomains.md#op-setdomainforwarding) | external |
|
|
2200
|
+
| POST | `/api/v1/provider-domains/{domain_id}/info` | [`g8.api.providerDomains.getDomainInfo`](providerDomains.md#op-getdomaininfo) | read |
|
|
2201
|
+
| POST | `/api/v1/provider-domains/{domain_id}/mailbox-profile-picture` | [`g8.api.providerDomains.updateMailboxProfilePicture`](providerDomains.md#op-updatemailboxprofilepicture) | external |
|
|
2202
|
+
| GET | `/api/v1/provider-domains/{domain_id}/mailboxes` | [`g8.api.providerDomains.listDomainMailboxes`](providerDomains.md#op-listdomainmailboxes) | read |
|
|
2203
|
+
| POST | `/api/v1/provider-domains/{domain_id}/provider-status` | [`g8.api.providerDomains.getProviderStatus`](providerDomains.md#op-getproviderstatus) | read |
|
|
2204
|
+
| POST | `/api/v1/provider-domains/{domain_id}/provisioning-states` | [`g8.api.providerDomains.getProvisioningStates`](providerDomains.md#op-getprovisioningstates) | read |
|
|
2205
|
+
| POST | `/api/v1/provider-domains/{domain_id}/refresh-from-provider` | [`g8.api.providerDomains.refreshDomainFromProvider`](providerDomains.md#op-refreshdomainfromprovider) | write |
|
|
2206
|
+
| POST | `/api/v1/provider-domains/{domain_id}/regenerate-nameservers` | [`g8.api.providerDomains.regenerateNameservers`](providerDomains.md#op-regeneratenameservers) | external |
|
|
2207
|
+
| POST | `/api/v1/provider-domains/{domain_id}/resend-transfer-password` | [`g8.api.providerDomains.resendTransferPassword`](providerDomains.md#op-resendtransferpassword) | external |
|
|
2208
|
+
| POST | `/api/v1/provider-domains/{domain_id}/resend-verification` | [`g8.api.providerDomains.resendRegistrantVerification`](providerDomains.md#op-resendregistrantverification) | external |
|
|
2209
|
+
| POST | `/api/v1/provider-domains/{domain_id}/reset-password` | [`g8.api.providerDomains.resetMailboxPassword`](providerDomains.md#op-resetmailboxpassword) | destructive |
|
|
2210
|
+
| POST | `/api/v1/provider-domains/{domain_id}/set-nameservers` | [`g8.api.providerDomains.setNameservers`](providerDomains.md#op-setnameservers) | external |
|
|
2211
|
+
| POST | `/api/v1/provider-domains/{domain_id}/transfer-info` | [`g8.api.providerDomains.getTransferInfo`](providerDomains.md#op-gettransferinfo) | read |
|
|
2212
|
+
| GET | `/api/v1/provider-usage` | [`g8.api.providerUsage.getProviderUsage`](providerUsage.md#op-getproviderusage) | read |
|
|
2213
|
+
| DELETE | `/api/v1/provider-usage/cache` | [`g8.api.providerUsage.clearProviderUsageCache`](providerUsage.md#op-clearproviderusagecache) | destructive |
|
|
2214
|
+
| POST | `/api/v1/provider-usage/refresh` | [`g8.api.providerUsage.refreshProviderUsage`](providerUsage.md#op-refreshproviderusage) | external |
|
|
2215
|
+
| POST | `/api/v1/provider-usage/sync` | [`g8.api.providerUsage.syncProviderUsageNow`](providerUsage.md#op-syncproviderusagenow) | external |
|
|
2216
|
+
| GET | `/api/v1/provider-usage/{provider}` | [`g8.api.providerUsage.getSingleProviderUsage`](providerUsage.md#op-getsingleproviderusage) | read |
|
|
2217
|
+
| POST | `/api/v1/public/copilot/chat` | [`g8.api.publicCopilot.publicCopilotChat`](publicCopilot.md#op-publiccopilotchat) or `g8.copilot.ask()` | write |
|
|
2218
|
+
| POST | `/api/v1/public/enrich/lookup` | [`g8.api.public.publicEnrichLookup`](public.md#op-publicenrichlookup) or `g8.forms.lookup()` | billable |
|
|
2219
|
+
| GET | `/api/v1/public/signals/company` | [`g8.api.publicSignals.publicSignalsCompany`](publicSignals.md#op-publicsignalscompany) or `g8.signals.company()` | read |
|
|
2220
|
+
| GET | `/api/v1/public/visitors/company` | [`g8.api.publicVisitors.publicVisitorCompany`](publicVisitors.md#op-publicvisitorcompany) or `g8.visitors.identify()` | read |
|
|
2221
|
+
| GET | `/api/v1/public/visitors/score` | [`g8.api.publicVisitors.publicVisitorScore`](publicVisitors.md#op-publicvisitorscore) or `g8.visitors.score()` | read |
|
|
2222
|
+
| GET | `/api/v1/quotable-products` | [`g8.api.quotes.listQuotableProducts`](quotes.md#op-listquotableproducts) or `g8.quotes.products()` | read |
|
|
2223
|
+
| POST | `/api/v1/quote-billing-contact` | [`g8.api.quotes.createQuoteBillingContact`](quotes.md#op-createquotebillingcontact) | external |
|
|
2224
|
+
| GET | `/api/v1/quote-contacts` | [`g8.api.quotes.searchQuoteContacts`](quotes.md#op-searchquotecontacts) | read |
|
|
2225
|
+
| POST | `/api/v1/quote-contacts` | [`g8.api.quotes.createQuoteContact`](quotes.md#op-createquotecontact) | external |
|
|
2226
|
+
| GET | `/api/v1/quote-settings` | [`g8.api.quotes.getQuoteSettings`](quotes.md#op-getquotesettings) or `g8.quotes.settings()` | read |
|
|
2227
|
+
| PUT | `/api/v1/quote-settings` | [`g8.api.quotes.updateQuoteSettings`](quotes.md#op-updatequotesettings) | external |
|
|
2228
|
+
| GET | `/api/v1/quote-settings/documents` | [`g8.api.quotes.listQuoteDocuments`](quotes.md#op-listquotedocuments) | read |
|
|
2229
|
+
| POST | `/api/v1/quote-settings/documents` | [`g8.api.quotes.uploadQuoteDocument`](quotes.md#op-uploadquotedocument) | external |
|
|
2230
|
+
| DELETE | `/api/v1/quote-settings/documents/{doc_id}` | [`g8.api.quotes.deleteQuoteDocument`](quotes.md#op-deletequotedocument) | destructive |
|
|
2231
|
+
| GET | `/api/v1/quote-templates` | [`g8.api.quotes.listQuoteTemplates`](quotes.md#op-listquotetemplates) | read |
|
|
2232
|
+
| POST | `/api/v1/quote-templates` | [`g8.api.quotes.createQuoteTemplate`](quotes.md#op-createquotetemplate) | external |
|
|
2233
|
+
| DELETE | `/api/v1/quote-templates/{template_id}` | [`g8.api.quotes.deleteQuoteTemplate`](quotes.md#op-deletequotetemplate) | destructive |
|
|
2234
|
+
| PUT | `/api/v1/quote-templates/{template_id}` | [`g8.api.quotes.updateQuoteTemplate`](quotes.md#op-updatequotetemplate) | external |
|
|
2235
|
+
| GET | `/api/v1/quotes` | [`g8.api.quotes.listQuotes`](quotes.md#op-listquotes) or `g8.quotes.list()` | read |
|
|
2236
|
+
| POST | `/api/v1/quotes` | [`g8.api.quotes.createQuote`](quotes.md#op-createquote) or `g8.quotes.create()` | external |
|
|
2237
|
+
| POST | `/api/v1/quotes/batch` | [`g8.api.quotes.batchQuoteAction`](quotes.md#op-batchquoteaction) | external |
|
|
2238
|
+
| POST | `/api/v1/quotes/mailbox-capacity` | [`g8.api.quotes.calculateMailboxCapacity`](quotes.md#op-calculatemailboxcapacity) | read |
|
|
2239
|
+
| POST | `/api/v1/quotes/payment-schedule` | [`g8.api.quotes.previewPaymentSchedule`](quotes.md#op-previewpaymentschedule) | read |
|
|
2240
|
+
| POST | `/api/v1/quotes/preview-draft` | [`g8.api.quotes.previewQuoteDraft`](quotes.md#op-previewquotedraft) | read |
|
|
2241
|
+
| DELETE | `/api/v1/quotes/{quote_id}` | [`g8.api.quotes.deleteQuote`](quotes.md#op-deletequote) or `g8.quotes.delete()` | destructive |
|
|
2242
|
+
| GET | `/api/v1/quotes/{quote_id}` | [`g8.api.quotes.getQuote`](quotes.md#op-getquote) or `g8.quotes.get()` | read |
|
|
2243
|
+
| PATCH | `/api/v1/quotes/{quote_id}` | [`g8.api.quotes.updateQuotePatch`](quotes.md#op-updatequotepatch) | external |
|
|
2244
|
+
| PUT | `/api/v1/quotes/{quote_id}` | [`g8.api.quotes.updateQuotePut`](quotes.md#op-updatequoteput) or `g8.quotes.update()` | external |
|
|
2245
|
+
| POST | `/api/v1/quotes/{quote_id}/archive` | [`g8.api.quotes.archiveQuote`](quotes.md#op-archivequote) | destructive |
|
|
2246
|
+
| POST | `/api/v1/quotes/{quote_id}/duplicate` | [`g8.api.quotes.duplicateQuote`](quotes.md#op-duplicatequote) or `g8.quotes.duplicate()` | external |
|
|
2247
|
+
| POST | `/api/v1/quotes/{quote_id}/edit-as-draft` | [`g8.api.quotes.editQuoteAsDraft`](quotes.md#op-editquoteasdraft) or `g8.quotes.editAsDraft()` | external |
|
|
2248
|
+
| GET | `/api/v1/quotes/{quote_id}/evidence` | [`g8.api.quotes.listQuoteEvidence`](quotes.md#op-listquoteevidence) | read |
|
|
2249
|
+
| POST | `/api/v1/quotes/{quote_id}/evidence` | [`g8.api.quotes.uploadQuoteEvidence`](quotes.md#op-uploadquoteevidence) | write |
|
|
2250
|
+
| GET | `/api/v1/quotes/{quote_id}/evidence/{evidence_id}` | [`g8.api.quotes.downloadQuoteEvidence`](quotes.md#op-downloadquoteevidence) | read |
|
|
2251
|
+
| POST | `/api/v1/quotes/{quote_id}/expire` | [`g8.api.quotes.expireQuote`](quotes.md#op-expirequote) | destructive |
|
|
2252
|
+
| POST | `/api/v1/quotes/{quote_id}/mark-accepted` | [`g8.api.quotes.markQuoteAccepted`](quotes.md#op-markquoteaccepted) | external |
|
|
2253
|
+
| GET | `/api/v1/quotes/{quote_id}/pdf` | [`g8.api.quotes.getQuotePdf`](quotes.md#op-getquotepdf) | read |
|
|
2254
|
+
| POST | `/api/v1/quotes/{quote_id}/revoke` | [`g8.api.quotes.revokeQuote`](quotes.md#op-revokequote) | destructive |
|
|
2255
|
+
| POST | `/api/v1/quotes/{quote_id}/send` | [`g8.api.quotes.sendQuote`](quotes.md#op-sendquote) or `g8.quotes.send()` | external |
|
|
2256
|
+
| POST | `/api/v1/quotes/{quote_id}/send-preview` | [`g8.api.quotes.previewQuoteSend`](quotes.md#op-previewquotesend) | read |
|
|
2257
|
+
| POST | `/api/v1/quotes/{quote_id}/unarchive` | [`g8.api.quotes.unarchiveQuote`](quotes.md#op-unarchivequote) | external |
|
|
2258
|
+
| GET | `/api/v1/radar/aeo` | [`g8.api.radar.aeoOverview`](radar.md#op-aeooverview) | read |
|
|
2259
|
+
| GET | `/api/v1/radar/aeo/dossier/{probe_id}` | [`g8.api.radarReports.getRadarAeoDossier`](radarReports.md#op-getradaraeodossier) | read |
|
|
2260
|
+
| GET | `/api/v1/radar/aeo/probes` | [`g8.api.radar.aeoProbes`](radar.md#op-aeoprobes) | read |
|
|
2261
|
+
| POST | `/api/v1/radar/aeo/run` | [`g8.api.radar.aeoRun`](radar.md#op-aeorun) | billable |
|
|
2262
|
+
| GET | `/api/v1/radar/aeo/sources` | [`g8.api.radarReports.getRadarAeoSources`](radarReports.md#op-getradaraeosources) | read |
|
|
2263
|
+
| POST | `/api/v1/radar/alerts/dispatch` | [`g8.api.radar.dispatchAlerts`](radar.md#op-dispatchalerts) | external |
|
|
2264
|
+
| GET | `/api/v1/radar/case-files` | [`g8.api.radarReports.listRadarCaseFiles`](radarReports.md#op-listradarcasefiles) | read |
|
|
2265
|
+
| POST | `/api/v1/radar/case-files/{case_id}/action` | [`g8.api.radarReports.actOnRadarCaseFile`](radarReports.md#op-actonradarcasefile) | write |
|
|
2266
|
+
| GET | `/api/v1/radar/competitors` | [`g8.api.radar.listCompetitors`](radar.md#op-listcompetitors) | read |
|
|
2267
|
+
| POST | `/api/v1/radar/competitors` | [`g8.api.radar.createCompetitor`](radar.md#op-createcompetitor) | billable |
|
|
2268
|
+
| POST | `/api/v1/radar/competitors/bulk` | [`g8.api.radar.bulkAddCompetitors`](radar.md#op-bulkaddcompetitors) | billable |
|
|
2269
|
+
| GET | `/api/v1/radar/competitors/suggestions` | [`g8.api.radar.competitorSuggestions`](radar.md#op-competitorsuggestions) | read |
|
|
2270
|
+
| DELETE | `/api/v1/radar/competitors/{competitor_id}` | [`g8.api.radar.deleteCompetitor`](radar.md#op-deletecompetitor) | destructive |
|
|
2271
|
+
| GET | `/api/v1/radar/competitors/{competitor_id}` | [`g8.api.radar.getCompetitor`](radar.md#op-getcompetitor) | read |
|
|
2272
|
+
| PATCH | `/api/v1/radar/competitors/{competitor_id}` | [`g8.api.radar.updateCompetitor`](radar.md#op-updatecompetitor) | billable |
|
|
2273
|
+
| GET | `/api/v1/radar/competitors/{competitor_id}/ads` | [`g8.api.radar.getCompetitorAds`](radar.md#op-getcompetitorads) | read |
|
|
2274
|
+
| GET | `/api/v1/radar/competitors/{competitor_id}/battle-card` | [`g8.api.radar.competitorBattleCard`](radar.md#op-competitorbattlecard) | read |
|
|
2275
|
+
| GET | `/api/v1/radar/competitors/{competitor_id}/discover-pages` | [`g8.api.radar.discoverCompetitorPages`](radar.md#op-discovercompetitorpages) | billable |
|
|
2276
|
+
| GET | `/api/v1/radar/competitors/{competitor_id}/engagers` | [`g8.api.radar.getCompetitorEngagers`](radar.md#op-getcompetitorengagers) | read |
|
|
2277
|
+
| GET | `/api/v1/radar/competitors/{competitor_id}/pages` | [`g8.api.radar.getCompetitorPages`](radar.md#op-getcompetitorpages) | read |
|
|
2278
|
+
| GET | `/api/v1/radar/competitors/{competitor_id}/posts` | [`g8.api.radar.getCompetitorPosts`](radar.md#op-getcompetitorposts) | read |
|
|
2279
|
+
| POST | `/api/v1/radar/competitors/{competitor_id}/scan` | [`g8.api.radar.scanCompetitor`](radar.md#op-scancompetitor) | billable |
|
|
2280
|
+
| GET | `/api/v1/radar/competitors/{competitor_id}/traffic` | [`g8.api.radar.getCompetitorTraffic`](radar.md#op-getcompetitortraffic) | read |
|
|
2281
|
+
| GET | `/api/v1/radar/feature-matrix` | [`g8.api.radar.featureMatrix`](radar.md#op-featurematrix) | read |
|
|
2282
|
+
| GET | `/api/v1/radar/gaps` | [`g8.api.radar.listGaps`](radar.md#op-listgaps) | read |
|
|
2283
|
+
| POST | `/api/v1/radar/gaps/analyze` | [`g8.api.radar.analyzeGaps`](radar.md#op-analyzegaps) | billable |
|
|
2284
|
+
| PATCH | `/api/v1/radar/gaps/{gap_id}` | [`g8.api.radar.updateGap`](radar.md#op-updategap) | billable |
|
|
2285
|
+
| GET | `/api/v1/radar/initiatives` | [`g8.api.radar.listInitiatives`](radar.md#op-listinitiatives) | read |
|
|
2286
|
+
| POST | `/api/v1/radar/initiatives/measure` | [`g8.api.radar.measureInitiatives`](radar.md#op-measureinitiatives) | billable |
|
|
2287
|
+
| GET | `/api/v1/radar/keyword-gap` | [`g8.api.radar.keywordGap`](radar.md#op-keywordgap) | read |
|
|
2288
|
+
| GET | `/api/v1/radar/monitoring/ads` | [`g8.api.radar.monitoringAds`](radar.md#op-monitoringads) | read |
|
|
2289
|
+
| GET | `/api/v1/radar/monitoring/ads/{ad_id}` | [`g8.api.radar.monitoringAdDetail`](radar.md#op-monitoringaddetail) | read |
|
|
2290
|
+
| GET | `/api/v1/radar/monitoring/content` | [`g8.api.radar.monitoringContent`](radar.md#op-monitoringcontent) | read |
|
|
2291
|
+
| GET | `/api/v1/radar/monitoring/linkedin` | [`g8.api.radar.monitoringLinkedin`](radar.md#op-monitoringlinkedin) | read |
|
|
2292
|
+
| GET | `/api/v1/radar/monitoring/page-history` | [`g8.api.radar.pageHistory`](radar.md#op-pagehistory) | read |
|
|
2293
|
+
| GET | `/api/v1/radar/opportunities` | [`g8.api.radar.listOpportunities`](radar.md#op-listopportunities) | read |
|
|
2294
|
+
| POST | `/api/v1/radar/opportunities/approve-all` | [`g8.api.radar.approveAllOpportunities`](radar.md#op-approveallopportunities) | billable |
|
|
2295
|
+
| POST | `/api/v1/radar/opportunities/{gap_id}/approve` | [`g8.api.radar.approveOpportunity`](radar.md#op-approveopportunity) | billable |
|
|
2296
|
+
| GET | `/api/v1/radar/optimization-runs` | [`g8.api.radar.optimizationRuns`](radar.md#op-optimizationruns) | read |
|
|
2297
|
+
| GET | `/api/v1/radar/overview` | [`g8.api.radar.overview`](radar.md#op-overview) | read |
|
|
2298
|
+
| GET | `/api/v1/radar/own-traffic-estimate` | [`g8.api.radar.ownTrafficEstimate`](radar.md#op-owntrafficestimate) | read |
|
|
2299
|
+
| GET | `/api/v1/radar/reports` | [`g8.api.radarReports.listRadarReports`](radarReports.md#op-listradarreports) | read |
|
|
2300
|
+
| POST | `/api/v1/radar/reports` | [`g8.api.radarReports.createRadarReport`](radarReports.md#op-createradarreport) | billable |
|
|
2301
|
+
| GET | `/api/v1/radar/reports/{report_id}/html` | [`g8.api.radarReports.getRadarReportHtml`](radarReports.md#op-getradarreporthtml) | read |
|
|
2302
|
+
| GET | `/api/v1/radar/reports/{report_id}/pdf` | [`g8.api.radarReports.getRadarReportPdf`](radarReports.md#op-getradarreportpdf) | read |
|
|
2303
|
+
| POST | `/api/v1/radar/scan-all` | [`g8.api.radar.scanAllCompetitors`](radar.md#op-scanallcompetitors) | billable |
|
|
2304
|
+
| GET | `/api/v1/radar/settings` | [`g8.api.radar.getSettings`](radar.md#op-getsettings) | read |
|
|
2305
|
+
| PUT | `/api/v1/radar/settings` | [`g8.api.radar.putSettings`](radar.md#op-putsettings) | billable |
|
|
2306
|
+
| GET | `/api/v1/radar/snapshots/{snapshot_id}/compare` | [`g8.api.radar.compareSnapshot`](radar.md#op-comparesnapshot) | read |
|
|
2307
|
+
| GET | `/api/v1/radar/traffic` | [`g8.api.radar.traffic`](radar.md#op-traffic) | read |
|
|
2308
|
+
| POST | `/api/v1/records/{entity_type}/{entity_id}/role-assignments` | [`g8.api.recordRoles.assignRecordRole`](recordRoles.md#op-assignrecordrole) | write |
|
|
2309
|
+
| DELETE | `/api/v1/records/{entity_type}/{entity_id}/role-assignments/{role_slot}` | [`g8.api.recordRoles.clearRecordRole`](recordRoles.md#op-clearrecordrole) | destructive |
|
|
2310
|
+
| GET | `/api/v1/records/{entity_type}/{entity_id}/role-history` | [`g8.api.recordRoles.getRecordRoleHistory`](recordRoles.md#op-getrecordrolehistory) | read |
|
|
2311
|
+
| GET | `/api/v1/records/{entity_type}/{entity_id}/role-slots` | [`g8.api.recordRoles.getRecordRoleSlots`](recordRoles.md#op-getrecordroleslots) | read |
|
|
2312
|
+
| GET | `/api/v1/repos` | [`g8.api.repos.listRepos`](repos.md#op-listrepos) | read |
|
|
2313
|
+
| POST | `/api/v1/repos` | [`g8.api.repos.connectRepo`](repos.md#op-connectrepo) | write |
|
|
2314
|
+
| DELETE | `/api/v1/repos/{repo_id}` | [`g8.api.repos.deleteRepo`](repos.md#op-deleterepo) | destructive |
|
|
2315
|
+
| GET | `/api/v1/repos/{repo_id}` | [`g8.api.repos.getRepo`](repos.md#op-getrepo) | read |
|
|
2316
|
+
| GET | `/api/v1/repos/{repo_id}/campaigns` | [`g8.api.cliCampaigns.listCampaigns`](cliCampaigns.md#op-listcampaigns) | read |
|
|
2317
|
+
| POST | `/api/v1/repos/{repo_id}/campaigns` | [`g8.api.cliCampaigns.createCampaign`](cliCampaigns.md#op-createcampaign) | write |
|
|
2318
|
+
| GET | `/api/v1/repos/{repo_id}/campaigns/{campaign_id}` | [`g8.api.cliCampaigns.getCampaign`](cliCampaigns.md#op-getcampaign) | read |
|
|
2319
|
+
| PATCH | `/api/v1/repos/{repo_id}/campaigns/{campaign_id}` | [`g8.api.cliCampaigns.updateCampaign`](cliCampaigns.md#op-updatecampaign) | write |
|
|
2320
|
+
| GET | `/api/v1/repos/{repo_id}/campaigns/{campaign_id}/documents/{document_id}` | [`g8.api.cliCampaigns.getCampaignDocument`](cliCampaigns.md#op-getcampaigndocument) | read |
|
|
2321
|
+
| POST | `/api/v1/repos/{repo_id}/campaigns/{campaign_id}/launch` | [`g8.api.cliCampaigns.launchCampaign`](cliCampaigns.md#op-launchcampaign) | external |
|
|
2322
|
+
| POST | `/api/v1/repos/{repo_id}/install` | [`g8.api.install.generateInstall`](install.md#op-generateinstall) | write |
|
|
2323
|
+
| POST | `/api/v1/repos/{repo_id}/install/apply` | [`g8.api.install.applyInstall`](install.md#op-applyinstall) | write |
|
|
2324
|
+
| GET | `/api/v1/repos/{repo_id}/install/status` | [`g8.api.install.getInstallStatus`](install.md#op-getinstallstatus) | read |
|
|
2325
|
+
| GET | `/api/v1/repos/{repo_id}/kb` | [`g8.api.knowledgeBase.listKbDocuments`](knowledgeBase.md#op-listkbdocuments) | read |
|
|
2326
|
+
| POST | `/api/v1/repos/{repo_id}/kb/search` | [`g8.api.knowledgeBase.searchKb`](knowledgeBase.md#op-searchkb) | write |
|
|
2327
|
+
| POST | `/api/v1/repos/{repo_id}/rollback` | [`g8.api.install.rollbackInstall`](install.md#op-rollbackinstall) | write |
|
|
2328
|
+
| GET | `/api/v1/repos/{repo_id}/scan` | [`g8.api.scans.getScan`](scans.md#op-getscan) | billable |
|
|
2329
|
+
| POST | `/api/v1/repos/{repo_id}/scan` | [`g8.api.scans.createScan`](scans.md#op-createscan) | billable |
|
|
2330
|
+
| GET | `/api/v1/repos/{repo_id}/snippet` | [`g8.api.install.getSnippet`](install.md#op-getsnippet) | read |
|
|
2331
|
+
| GET | `/api/v1/repos/{repo_id}/streams` | [`g8.api.install.listStreams`](install.md#op-liststreams) | read |
|
|
2332
|
+
| GET | `/api/v1/research-reports` | [`g8.api.gtmContext.listResearchReports`](gtmContext.md#op-listresearchreports) or `g8.studio.researchReports()` | read |
|
|
2333
|
+
| GET | `/api/v1/research-reports/by-number/{report_number}` | [`g8.api.research.getResearchReportByNumber`](research.md#op-getresearchreportbynumber) | read |
|
|
2334
|
+
| POST | `/api/v1/research-reports/generate` | [`g8.api.research.generateResearchReport`](research.md#op-generateresearchreport) | billable |
|
|
2335
|
+
| POST | `/api/v1/research-reports/generate-all` | [`g8.api.research.generateAllResearchReports`](research.md#op-generateallresearchreports) | billable |
|
|
2336
|
+
| POST | `/api/v1/research-reports/retry` | [`g8.api.research.retryResearchReport`](research.md#op-retryresearchreport) | billable |
|
|
2337
|
+
| POST | `/api/v1/research-reports/scaffold` | [`g8.api.research.scaffoldResearchReports`](research.md#op-scaffoldresearchreports) | write |
|
|
2338
|
+
| POST | `/api/v1/research-reports/stop-all` | [`g8.api.research.stopAllResearch`](research.md#op-stopallresearch) | write |
|
|
2339
|
+
| GET | `/api/v1/research-reports/workflow` | [`g8.api.research.getResearchWorkflowStatus`](research.md#op-getresearchworkflowstatus) | read |
|
|
2340
|
+
| POST | `/api/v1/research-reports/workflow/reset` | [`g8.api.research.resetResearchWorkflow`](research.md#op-resetresearchworkflow) | destructive |
|
|
2341
|
+
| POST | `/api/v1/research-reports/workflow/resume` | [`g8.api.research.resumeResearchWorkflow`](research.md#op-resumeresearchworkflow) | billable |
|
|
2342
|
+
| DELETE | `/api/v1/research-reports/{report_id}` | [`g8.api.research.deleteResearchReport`](research.md#op-deleteresearchreport) | destructive |
|
|
2343
|
+
| GET | `/api/v1/research-reports/{report_id}` | [`g8.api.research.getResearchReport`](research.md#op-getresearchreport) | read |
|
|
2344
|
+
| PATCH | `/api/v1/research-reports/{report_id}` | [`g8.api.gtmContext.updateResearchReport`](gtmContext.md#op-updateresearchreport) | billable |
|
|
2345
|
+
| POST | `/api/v1/research-reports/{report_id}/approve` | [`g8.api.research.approveResearchReport`](research.md#op-approveresearchreport) | write |
|
|
2346
|
+
| GET | `/api/v1/research-reports/{report_id}/thinking` | [`g8.api.companyIntelligence.getResearchReportThinking`](companyIntelligence.md#op-getresearchreportthinking) | read |
|
|
2347
|
+
| POST | `/api/v1/research-reports/{report_id}/unapprove` | [`g8.api.research.unapproveResearchReport`](research.md#op-unapproveresearchreport) | write |
|
|
2348
|
+
| POST | `/api/v1/revenue/backfills/estimate` | [`g8.api.revenue.estimateAllStageDocBackfills`](revenue.md#op-estimateallstagedocbackfills) | read |
|
|
2349
|
+
| GET | `/api/v1/revenue/backfills/{job_id}` | [`g8.api.revenue.getStageDocBackfillJob`](revenue.md#op-getstagedocbackfilljob) | read |
|
|
2350
|
+
| POST | `/api/v1/revenue/backfills/{job_id}/cancel` | [`g8.api.revenue.cancelStageDocBackfillJob`](revenue.md#op-cancelstagedocbackfilljob) | destructive |
|
|
2351
|
+
| PUT | `/api/v1/revenue/lifecycle` | [`g8.api.revenue.updateLifecycles`](revenue.md#op-updatelifecycles) | write |
|
|
2352
|
+
| GET | `/api/v1/revenue/lifecycle/event-catalog` | [`g8.api.revenue.getEventCatalog`](revenue.md#op-geteventcatalog) | read |
|
|
2353
|
+
| POST | `/api/v1/revenue/lifecycle/seed-defaults` | [`g8.api.revenue.seedLifecycleDefaults`](revenue.md#op-seedlifecycledefaults) | destructive |
|
|
2354
|
+
| POST | `/api/v1/revenue/lifecycle/sync-lists` | [`g8.api.revenue.syncLifecycleLists`](revenue.md#op-synclifecyclelists) | write |
|
|
2355
|
+
| GET | `/api/v1/revenue/plans` | [`g8.api.revenueRecords.listRevenuePlans`](revenueRecords.md#op-listrevenueplans) | read |
|
|
2356
|
+
| POST | `/api/v1/revenue/plans` | [`g8.api.revenueRecords.createRevenuePlan`](revenueRecords.md#op-createrevenueplan) | write |
|
|
2357
|
+
| POST | `/api/v1/revenue/plans/normalize` | [`g8.api.revenueRecords.normalizeRevenuePlans`](revenueRecords.md#op-normalizerevenueplans) | write |
|
|
2358
|
+
| DELETE | `/api/v1/revenue/plans/{plan_id}` | [`g8.api.revenueRecords.deactivateRevenuePlan`](revenueRecords.md#op-deactivaterevenueplan) | destructive |
|
|
2359
|
+
| PUT | `/api/v1/revenue/plans/{plan_id}` | [`g8.api.revenueRecords.updateRevenuePlan`](revenueRecords.md#op-updaterevenueplan) | write |
|
|
2360
|
+
| GET | `/api/v1/revenue/stage-docs/catalog` | [`g8.api.revenue.getStageDocCatalog`](revenue.md#op-getstagedoccatalog) | read |
|
|
2361
|
+
| GET | `/api/v1/revenue/stage-docs/defaults` | [`g8.api.revenue.getStageDocDefaults`](revenue.md#op-getstagedocdefaults) | read |
|
|
2362
|
+
| GET | `/api/v1/revenue/stage-docs/{lifecycle_entry_id}/{entity}` | [`g8.api.revenue.getStageDocSlot`](revenue.md#op-getstagedocslot) | read |
|
|
2363
|
+
| PATCH | `/api/v1/revenue/stage-docs/{lifecycle_entry_id}/{entity}` | [`g8.api.revenue.patchStageDocSlot`](revenue.md#op-patchstagedocslot) | write |
|
|
2364
|
+
| POST | `/api/v1/revenue/stage-docs/{lifecycle_entry_id}/{entity}/backfill` | [`g8.api.revenue.startStageDocBackfill`](revenue.md#op-startstagedocbackfill) | billable |
|
|
2365
|
+
| POST | `/api/v1/revenue/stage-docs/{lifecycle_entry_id}/{entity}/backfill/estimate` | [`g8.api.revenue.estimateStageDocBackfill`](revenue.md#op-estimatestagedocbackfill) | read |
|
|
2366
|
+
| POST | `/api/v1/revenue/stage-docs/{lifecycle_entry_id}/{entity}/reset` | [`g8.api.revenue.resetStageDocSlot`](revenue.md#op-resetstagedocslot) | destructive |
|
|
2367
|
+
| GET | `/api/v1/roles` | [`g8.api.roles.listRoles`](roles.md#op-listroles) | read |
|
|
2368
|
+
| POST | `/api/v1/roles` | [`g8.api.roles.createRole`](roles.md#op-createrole) | write |
|
|
2369
|
+
| GET | `/api/v1/roles/domain-settings` | [`g8.api.roles.getDomainSettings`](roles.md#op-getdomainsettings) | read |
|
|
2370
|
+
| GET | `/api/v1/roles/join-requests` | [`g8.api.roles.listJoinRequests`](roles.md#op-listjoinrequests) | read |
|
|
2371
|
+
| GET | `/api/v1/roles/join-requests/count` | [`g8.api.roles.getJoinRequestCount`](roles.md#op-getjoinrequestcount) | read |
|
|
2372
|
+
| POST | `/api/v1/roles/join-requests/{request_id}/reject` | [`g8.api.roles.rejectJoinRequest`](roles.md#op-rejectjoinrequest) | write |
|
|
2373
|
+
| GET | `/api/v1/roles/me/permissions` | [`g8.api.roles.getMyPermissions`](roles.md#op-getmypermissions) | read |
|
|
2374
|
+
| GET | `/api/v1/roles/options` | [`g8.api.roles.listRoleOptions`](roles.md#op-listroleoptions) | read |
|
|
2375
|
+
| GET | `/api/v1/roles/org-users` | [`g8.api.roles.listOrgUsers`](roles.md#op-listorgusers) | read |
|
|
2376
|
+
| GET | `/api/v1/roles/pending-invites` | [`g8.api.roles.listPendingInvites`](roles.md#op-listpendinginvites) | read |
|
|
2377
|
+
| DELETE | `/api/v1/roles/pending-invites/{email}` | [`g8.api.roles.revokePendingInvite`](roles.md#op-revokependinginvite) | destructive |
|
|
2378
|
+
| GET | `/api/v1/roles/permissions` | [`g8.api.roles.listPermissions`](roles.md#op-listpermissions) | read |
|
|
2379
|
+
| GET | `/api/v1/roles/permissions/grouped` | [`g8.api.roles.listPermissionsGrouped`](roles.md#op-listpermissionsgrouped) | read |
|
|
2380
|
+
| GET | `/api/v1/roles/service-provider/assignments` | [`g8.api.roles.listServiceProviderAssignments`](roles.md#op-listserviceproviderassignments) | read |
|
|
2381
|
+
| DELETE | `/api/v1/roles/service-provider/assignments/{email}` | [`g8.api.roles.deleteServiceProviderAssignments`](roles.md#op-deleteserviceproviderassignments) | destructive |
|
|
2382
|
+
| GET | `/api/v1/roles/service-provider/available-lists` | [`g8.api.roles.listServiceProviderAvailableLists`](roles.md#op-listserviceprovideravailablelists) | read |
|
|
2383
|
+
| GET | `/api/v1/roles/users/{user_id}` | [`g8.api.roles.getUserRole`](roles.md#op-getuserrole) | read |
|
|
2384
|
+
| DELETE | `/api/v1/roles/{role_id}` | [`g8.api.roles.deleteRole`](roles.md#op-deleterole) | destructive |
|
|
2385
|
+
| GET | `/api/v1/roles/{role_id}` | [`g8.api.roles.getRole`](roles.md#op-getrole) | read |
|
|
2386
|
+
| PUT | `/api/v1/roles/{role_id}` | [`g8.api.roles.updateRole`](roles.md#op-updaterole) | destructive |
|
|
2387
|
+
| GET | `/api/v1/sales-coach/calls` | [`g8.api.salesCoach.listCalls`](salesCoach.md#op-listcalls) | read |
|
|
2388
|
+
| POST | `/api/v1/sales-coach/calls` | [`g8.api.salesCoach.createCall`](salesCoach.md#op-createcall) | write |
|
|
2389
|
+
| DELETE | `/api/v1/sales-coach/calls/{call_id}` | [`g8.api.salesCoach.deleteCall`](salesCoach.md#op-deletecall) | destructive |
|
|
2390
|
+
| GET | `/api/v1/sales-coach/calls/{call_id}` | [`g8.api.salesCoach.getCall`](salesCoach.md#op-getcall) | read |
|
|
2391
|
+
| PUT | `/api/v1/sales-coach/calls/{call_id}` | [`g8.api.salesCoach.updateCall`](salesCoach.md#op-updatecall) | write |
|
|
2392
|
+
| GET | `/api/v1/sales-coach/calls/{call_id}/audio-url` | [`g8.api.salesCoach.getCallAudioUrl`](salesCoach.md#op-getcallaudiourl) | read |
|
|
2393
|
+
| GET | `/api/v1/sales-coach/calls/{call_id}/transcript` | [`g8.api.salesCoach.getCallTranscript`](salesCoach.md#op-getcalltranscript) | read |
|
|
2394
|
+
| GET | `/api/v1/sales-coach/contact-lists` | [`g8.api.salesCoach.listCoachContactLists`](salesCoach.md#op-listcoachcontactlists) | read |
|
|
2395
|
+
| GET | `/api/v1/sales-coach/interview-attempts` | [`g8.api.salesCoach.listInterviewAttempts`](salesCoach.md#op-listinterviewattempts) | read |
|
|
2396
|
+
| POST | `/api/v1/sales-coach/interview-attempts` | [`g8.api.salesCoach.createInterviewAttempt`](salesCoach.md#op-createinterviewattempt) | write |
|
|
2397
|
+
| POST | `/api/v1/sales-coach/interview-attempts/by-code/{code}` | [`g8.api.salesCoach.createInterviewAttemptByCode`](salesCoach.md#op-createinterviewattemptbycode) | write |
|
|
2398
|
+
| GET | `/api/v1/sales-coach/interviews` | [`g8.api.salesCoach.listInterviews`](salesCoach.md#op-listinterviews) | read |
|
|
2399
|
+
| POST | `/api/v1/sales-coach/interviews` | [`g8.api.salesCoach.createInterview`](salesCoach.md#op-createinterview) | write |
|
|
2400
|
+
| GET | `/api/v1/sales-coach/interviews/by-code/{code}` | [`g8.api.salesCoach.getInterviewByCode`](salesCoach.md#op-getinterviewbycode) | read |
|
|
2401
|
+
| DELETE | `/api/v1/sales-coach/interviews/{interview_id}` | [`g8.api.salesCoach.deleteInterview`](salesCoach.md#op-deleteinterview) | destructive |
|
|
2402
|
+
| GET | `/api/v1/sales-coach/interviews/{interview_id}` | [`g8.api.salesCoach.getInterview`](salesCoach.md#op-getinterview) | read |
|
|
2403
|
+
| POST | `/api/v1/sales-coach/interviews/{interview_id}/members` | [`g8.api.salesCoach.addInterviewMember`](salesCoach.md#op-addinterviewmember) | external |
|
|
2404
|
+
| POST | `/api/v1/sales-coach/interviews/{interview_id}/members/{member_id}/send-invite` | [`g8.api.salesCoach.sendInterviewInvite`](salesCoach.md#op-sendinterviewinvite) | external |
|
|
2405
|
+
| GET | `/api/v1/sales-coach/leaderboard` | [`g8.api.salesCoach.getSalesCoachLeaderboard`](salesCoach.md#op-getsalescoachleaderboard) | read |
|
|
2406
|
+
| GET | `/api/v1/sales-coach/prospects/search` | [`g8.api.salesCoach.searchCoachProspects`](salesCoach.md#op-searchcoachprospects) | read |
|
|
2407
|
+
| GET | `/api/v1/sales-coach/team/active-users-summary` | [`g8.api.salesCoach.getTeamActiveUsersSummary`](salesCoach.md#op-getteamactiveuserssummary) | read |
|
|
2408
|
+
| GET | `/api/v1/sales-coach/team/bootstrap` | [`g8.api.salesCoach.getTeamBootstrap`](salesCoach.md#op-getteambootstrap) | read |
|
|
2409
|
+
| GET | `/api/v1/sales-coach/team/config` | [`g8.api.salesCoach.getTeamConfig`](salesCoach.md#op-getteamconfig) | read |
|
|
2410
|
+
| PUT | `/api/v1/sales-coach/team/config` | [`g8.api.salesCoach.updateTeamConfig`](salesCoach.md#op-updateteamconfig) | write |
|
|
2411
|
+
| GET | `/api/v1/sales-coach/team/kpi-catalog` | [`g8.api.salesCoach.getTeamKpiCatalog`](salesCoach.md#op-getteamkpicatalog) | read |
|
|
2412
|
+
| GET | `/api/v1/sales-coach/team/leaderboards` | [`g8.api.salesCoach.listTeamLeaderboards`](salesCoach.md#op-listteamleaderboards) | read |
|
|
2413
|
+
| POST | `/api/v1/sales-coach/team/leaderboards` | [`g8.api.salesCoach.createTeamLeaderboard`](salesCoach.md#op-createteamleaderboard) | write |
|
|
2414
|
+
| DELETE | `/api/v1/sales-coach/team/leaderboards/{lb_id}` | [`g8.api.salesCoach.deleteTeamLeaderboard`](salesCoach.md#op-deleteteamleaderboard) | destructive |
|
|
2415
|
+
| PUT | `/api/v1/sales-coach/team/leaderboards/{lb_id}` | [`g8.api.salesCoach.updateTeamLeaderboard`](salesCoach.md#op-updateteamleaderboard) | write |
|
|
2416
|
+
| GET | `/api/v1/sales-coach/team/leaderboards/{lb_id}/data` | [`g8.api.salesCoach.getTeamLeaderboardData`](salesCoach.md#op-getteamleaderboarddata) | read |
|
|
2417
|
+
| GET | `/api/v1/sales-coach/team/roles` | [`g8.api.salesCoach.listTeamRoles`](salesCoach.md#op-listteamroles) | read |
|
|
2418
|
+
| GET | `/api/v1/sales-coach/team/sets` | [`g8.api.salesCoach.listTeamSets`](salesCoach.md#op-listteamsets) | read |
|
|
2419
|
+
| POST | `/api/v1/sales-coach/team/sets` | [`g8.api.salesCoach.createTeamSet`](salesCoach.md#op-createteamset) | write |
|
|
2420
|
+
| DELETE | `/api/v1/sales-coach/team/sets/{set_id}` | [`g8.api.salesCoach.deleteTeamSet`](salesCoach.md#op-deleteteamset) | destructive |
|
|
2421
|
+
| PUT | `/api/v1/sales-coach/team/sets/{set_id}` | [`g8.api.salesCoach.updateTeamSet`](salesCoach.md#op-updateteamset) | write |
|
|
2422
|
+
| GET | `/api/v1/sales-coach/team/sets/{set_id}/data` | [`g8.api.salesCoach.getTeamSetData`](salesCoach.md#op-getteamsetdata) | read |
|
|
2423
|
+
| PUT | `/api/v1/sales-coach/team/users/{user_id}/role` | [`g8.api.salesCoach.assignTeamRole`](salesCoach.md#op-assignteamrole) | destructive |
|
|
2424
|
+
| DELETE | `/api/v1/sandbox/failure-injection` | [`g8.api.sandbox.sandboxClearFailureRules`](sandbox.md#op-sandboxclearfailurerules) | destructive |
|
|
2425
|
+
| GET | `/api/v1/sandbox/failure-injection` | [`g8.api.sandbox.sandboxListFailureRules`](sandbox.md#op-sandboxlistfailurerules) | read |
|
|
2426
|
+
| PUT | `/api/v1/sandbox/failure-injection` | [`g8.api.sandbox.sandboxSetFailureRule`](sandbox.md#op-sandboxsetfailurerule) | write |
|
|
2427
|
+
| POST | `/api/v1/sandbox/fixtures/reset` | [`g8.api.sandbox.sandboxResetFixtures`](sandbox.md#op-sandboxresetfixtures) | destructive |
|
|
2428
|
+
| POST | `/api/v1/sandbox/fixtures/restore` | [`g8.api.sandbox.sandboxRestore`](sandbox.md#op-sandboxrestore) | destructive |
|
|
2429
|
+
| POST | `/api/v1/sandbox/fixtures/seed` | [`g8.api.sandbox.sandboxSeedFixtures`](sandbox.md#op-sandboxseedfixtures) | write |
|
|
2430
|
+
| POST | `/api/v1/sandbox/fixtures/snapshot` | [`g8.api.sandbox.sandboxSnapshot`](sandbox.md#op-sandboxsnapshot) | write |
|
|
2431
|
+
| GET | `/api/v1/sandbox/outbox` | [`g8.api.sandbox.sandboxOutbox`](sandbox.md#op-sandboxoutbox) | read |
|
|
2432
|
+
| GET | `/api/v1/sandbox/status` | [`g8.api.sandbox.sandboxStatus`](sandbox.md#op-sandboxstatus) | read |
|
|
2433
|
+
| GET | `/api/v1/schedules` | [`g8.api.gtmLaunchHelpers.listSchedules`](gtmLaunchHelpers.md#op-listschedules) | read |
|
|
2434
|
+
| POST | `/api/v1/schedules` | [`g8.api.sequences.createSchedule`](sequences.md#op-createschedule) | write |
|
|
2435
|
+
| GET | `/api/v1/schedules/{schedule_id}` | [`g8.api.sequences.getSchedule`](sequences.md#op-getschedule) | read |
|
|
2436
|
+
| PATCH | `/api/v1/schedules/{schedule_id}` | [`g8.api.sequences.updateSchedule`](sequences.md#op-updateschedule) | write |
|
|
2437
|
+
| PATCH | `/api/v1/schedules/{schedule_id}/archive` | [`g8.api.sequences.archiveSchedule`](sequences.md#op-archiveschedule) | destructive |
|
|
2438
|
+
| GET | `/api/v1/scrape/adapters` | [`g8.api.scraping.listScrapeAdapters`](scraping.md#op-listscrapeadapters) | read |
|
|
2439
|
+
| GET | `/api/v1/scrape/jobs/{job_id}` | [`g8.api.scraping.getScrapeJob`](scraping.md#op-getscrapejob) | read |
|
|
2440
|
+
| POST | `/api/v1/scrape/jobs/{job_id}/confirm` | [`g8.api.scraping.confirmScrapeJob`](scraping.md#op-confirmscrapejob) | write |
|
|
2441
|
+
| GET | `/api/v1/scrape/jobs/{job_id}/export.csv` | [`g8.api.scraping.exportScrapeJobCsv`](scraping.md#op-exportscrapejobcsv) | read |
|
|
2442
|
+
| POST | `/api/v1/scrape/jobs/{job_id}/reject` | [`g8.api.scraping.rejectScrapeJob`](scraping.md#op-rejectscrapejob) | write |
|
|
2443
|
+
| POST | `/api/v1/scrape/requests` | [`g8.api.scraping.submitScrapeRequest`](scraping.md#op-submitscraperequest) | billable |
|
|
2444
|
+
| GET | `/api/v1/search/autocomplete` | [`g8.api.search.getAutocompleteSuggestions`](search.md#op-getautocompletesuggestions) | read |
|
|
2445
|
+
| POST | `/api/v1/search/companies` | [`g8.api.search.searchCompanies`](search.md#op-searchcompanies) or `g8.search.companies()` | billable |
|
|
2446
|
+
| POST | `/api/v1/search/companies/save` | [`g8.api.search.saveCompanySearch`](search.md#op-savecompanysearch) or `g8.search.saveCompanies()` | billable |
|
|
2447
|
+
| POST | `/api/v1/search/contacts` | [`g8.api.search.searchContacts`](search.md#op-searchcontacts) or `g8.enrich.search()` | billable |
|
|
2448
|
+
| POST | `/api/v1/search/contacts/save` | [`g8.api.search.saveContactSearch`](search.md#op-savecontactsearch) or `g8.search.saveContacts()` | billable |
|
|
2449
|
+
| GET | `/api/v1/search/entities` | [`g8.api.search.searchCrmEntities`](search.md#op-searchcrmentities) | read |
|
|
2450
|
+
| GET | `/api/v1/search/filter-options` | [`g8.api.search.getFilterOptions`](search.md#op-getfilteroptions) | read |
|
|
2451
|
+
| POST | `/api/v1/search/filter-options` | [`g8.api.search.getFilteredFilterOptions`](search.md#op-getfilteredfilteroptions) | read |
|
|
2452
|
+
| GET | `/api/v1/search/filter-options/intent-topics` | [`g8.api.search.listIntentTopics`](search.md#op-listintenttopics) | read |
|
|
2453
|
+
| GET | `/api/v1/search/global` | [`g8.api.search.searchWorkspaceGlobal`](search.md#op-searchworkspaceglobal) | read |
|
|
2454
|
+
| GET | `/api/v1/search/saved-searches` | [`g8.api.search.listSavedSearches`](search.md#op-listsavedsearches) | read |
|
|
2455
|
+
| POST | `/api/v1/search/saved-searches` | [`g8.api.search.saveSearch`](search.md#op-savesearch) | write |
|
|
2456
|
+
| DELETE | `/api/v1/search/saved-searches/{query_id}` | [`g8.api.search.deleteSavedSearch`](search.md#op-deletesavedsearch) | destructive |
|
|
2457
|
+
| GET | `/api/v1/search/signals/options` | [`g8.api.search.getSearchSignalOptions`](search.md#op-getsearchsignaloptions) | read |
|
|
2458
|
+
| POST | `/api/v1/search/signals/preview` | [`g8.api.search.previewSearchSignal`](search.md#op-previewsearchsignal) | read |
|
|
2459
|
+
| GET | `/api/v1/search/signals/tech` | [`g8.api.search.suggestSearchSignalTech`](search.md#op-suggestsearchsignaltech) | read |
|
|
2460
|
+
| POST | `/api/v1/search/workspace` | [`g8.api.search.searchWorkspaceDocuments`](search.md#op-searchworkspacedocuments) | read |
|
|
2461
|
+
| GET | `/api/v1/search/workspace/sections` | [`g8.api.search.listWorkspaceSearchSections`](search.md#op-listworkspacesearchsections) | read |
|
|
2462
|
+
| POST | `/api/v1/search/workspace/suggest` | [`g8.api.search.suggestWorkspaceSearch`](search.md#op-suggestworkspacesearch) | read |
|
|
2463
|
+
| GET | `/api/v1/seo/audits` | [`g8.api.seo.listSeoAudits`](seo.md#op-listseoaudits) | read |
|
|
2464
|
+
| POST | `/api/v1/seo/audits` | [`g8.api.seo.startSeoAudit`](seo.md#op-startseoaudit) | billable |
|
|
2465
|
+
| GET | `/api/v1/seo/audits/{audit_id}` | [`g8.api.seo.getSeoAudit`](seo.md#op-getseoaudit) | read |
|
|
2466
|
+
| GET | `/api/v1/seo/audits/{audit_id}/issues` | [`g8.api.seo.getSeoAuditIssues`](seo.md#op-getseoauditissues) | read |
|
|
2467
|
+
| GET | `/api/v1/seo/domains/{domain}/backlinks` | [`g8.api.seo.getSeoDomainBacklinks`](seo.md#op-getseodomainbacklinks) | billable |
|
|
2468
|
+
| GET | `/api/v1/seo/domains/{domain}/overview` | [`g8.api.seo.getSeoDomainOverview`](seo.md#op-getseodomainoverview) | billable |
|
|
2469
|
+
| POST | `/api/v1/seo/keywords/research` | [`g8.api.seo.researchSeoKeywords`](seo.md#op-researchseokeywords) | billable |
|
|
2470
|
+
| GET | `/api/v1/seo/rank-tracking` | [`g8.api.seo.listSeoTrackedKeywords`](seo.md#op-listseotrackedkeywords) | read |
|
|
2471
|
+
| POST | `/api/v1/seo/rank-tracking/keywords` | [`g8.api.seo.saveSeoTrackedKeywords`](seo.md#op-saveseotrackedkeywords) | write |
|
|
2472
|
+
| POST | `/api/v1/seo/rank-tracking/keywords/remove` | [`g8.api.seo.removeSeoTrackedKeywords`](seo.md#op-removeseotrackedkeywords) | write |
|
|
2473
|
+
| GET | `/api/v1/seo/rank-tracking/{keyword_id}/history` | [`g8.api.seo.getSeoRankHistory`](seo.md#op-getseorankhistory) | read |
|
|
2474
|
+
| GET | `/api/v1/sequence-jobs/{job_id}` | [`g8.api.sequences.getSequenceJob`](sequences.md#op-getsequencejob) | read |
|
|
2475
|
+
| GET | `/api/v1/sequencer/agents/textual` | [`g8.api.sequences.listSequencerTextualAgents`](sequences.md#op-listsequencertextualagents) | read |
|
|
2476
|
+
| GET | `/api/v1/sequencer/agents/voice` | [`g8.api.sequences.listSequencerVoiceAgents`](sequences.md#op-listsequencervoiceagents) | read |
|
|
2477
|
+
| GET | `/api/v1/sequencer/channels/capacity-estimate` | [`g8.api.sequences.getSequencerCapacityEstimate`](sequences.md#op-getsequencercapacityestimate) | read |
|
|
2478
|
+
| GET | `/api/v1/sequencer/channels/linkedin_accounts` | [`g8.api.sequences.listLinkedinAccounts`](sequences.md#op-listlinkedinaccounts) | read |
|
|
2479
|
+
| GET | `/api/v1/sequencer/channels/mailboxes` | [`g8.api.sequences.listSequencerMailboxes`](sequences.md#op-listsequencermailboxes) | read |
|
|
2480
|
+
| GET | `/api/v1/sequencer/channels/phone_numbers` | [`g8.api.sequences.listSequencerPhoneNumbers`](sequences.md#op-listsequencerphonenumbers) | read |
|
|
2481
|
+
| GET | `/api/v1/sequencer/channels/sms_numbers` | [`g8.api.sequences.listSequencerSmsNumbers`](sequences.md#op-listsequencersmsnumbers) | read |
|
|
2482
|
+
| GET | `/api/v1/sequencer/channels/whatsapp_numbers` | [`g8.api.sequences.listSequencerWhatsappNumbers`](sequences.md#op-listsequencerwhatsappnumbers) | read |
|
|
2483
|
+
| GET | `/api/v1/sequencer/channels/whatsapp_templates` | [`g8.api.sequences.listSequencerWhatsappTemplates`](sequences.md#op-listsequencerwhatsapptemplates) | read |
|
|
2484
|
+
| POST | `/api/v1/sequencer/content/email/estimate` | [`g8.api.sequences.estimateEmailDraft`](sequences.md#op-estimateemaildraft) | read |
|
|
2485
|
+
| POST | `/api/v1/sequencer/content/email/generate` | [`g8.api.sequences.draftEmail`](sequences.md#op-draftemail) | billable |
|
|
2486
|
+
| GET | `/api/v1/sequencer/content/email/models` | [`g8.api.sequences.listEmailDraftModels`](sequences.md#op-listemaildraftmodels) | read |
|
|
2487
|
+
| POST | `/api/v1/sequencer/content/instructions/improve` | [`g8.api.sequences.improveStepInstruction`](sequences.md#op-improvestepinstruction) | billable |
|
|
2488
|
+
| POST | `/api/v1/sequencer/content/linkedin/generate` | [`g8.api.sequences.draftLinkedinMessage`](sequences.md#op-draftlinkedinmessage) | billable |
|
|
2489
|
+
| POST | `/api/v1/sequencer/content/voice/test-call` | [`g8.api.sequences.placeVoiceTestCall`](sequences.md#op-placevoicetestcall) | external |
|
|
2490
|
+
| GET | `/api/v1/sequencer/deliverability/provider-sizing` | [`g8.api.sequences.getProviderSizing`](sequences.md#op-getprovidersizing) | read |
|
|
2491
|
+
| GET | `/api/v1/sequencer/deliverability/seg-vendors` | [`g8.api.sequences.listSegVendors`](sequences.md#op-listsegvendors) | read |
|
|
2492
|
+
| GET | `/api/v1/sequencer/dialer/sequences` | [`g8.api.sequences.listDialerSequences`](sequences.md#op-listdialersequences) | read |
|
|
2493
|
+
| GET | `/api/v1/sequencer/dialer/sequences/{sequence_id}/contacts` | [`g8.api.sequences.listDialerContacts`](sequences.md#op-listdialercontacts) | read |
|
|
2494
|
+
| POST | `/api/v1/sequencer/dialer/sequences/{sequence_id}/contacts/{contact_id}/callback` | [`g8.api.sequences.recordDialerOutcome`](sequences.md#op-recorddialeroutcome) | write |
|
|
2495
|
+
| GET | `/api/v1/sequencer/stats` | [`g8.api.sequences.getSequencesOverview`](sequences.md#op-getsequencesoverview) | read |
|
|
2496
|
+
| GET | `/api/v1/sequencer/templates/sequences` | [`g8.api.sequences.listSequenceTemplates`](sequences.md#op-listsequencetemplates) | read |
|
|
2497
|
+
| POST | `/api/v1/sequencer/templates/sequences` | [`g8.api.sequences.createSequenceTemplate`](sequences.md#op-createsequencetemplate) | write |
|
|
2498
|
+
| PATCH | `/api/v1/sequencer/templates/sequences/{sequence_template_id}` | [`g8.api.sequences.updateSequenceTemplate`](sequences.md#op-updatesequencetemplate) | write |
|
|
2499
|
+
| PATCH | `/api/v1/sequencer/templates/sequences/{sequence_template_id}/archive` | [`g8.api.sequences.archiveSequenceTemplate`](sequences.md#op-archivesequencetemplate) | destructive |
|
|
2500
|
+
| GET | `/api/v1/sequencer/templates/steps` | [`g8.api.sequences.listStepTemplates`](sequences.md#op-liststeptemplates) | read |
|
|
2501
|
+
| POST | `/api/v1/sequencer/templates/steps` | [`g8.api.sequences.createStepTemplate`](sequences.md#op-createsteptemplate) | write |
|
|
2502
|
+
| POST | `/api/v1/sequencer/templates/steps/generate` | [`g8.api.sequences.generateStepTemplates`](sequences.md#op-generatesteptemplates) | billable |
|
|
2503
|
+
| PATCH | `/api/v1/sequencer/templates/steps/{step_template_id}` | [`g8.api.sequences.updateStepTemplate`](sequences.md#op-updatesteptemplate) | write |
|
|
2504
|
+
| PATCH | `/api/v1/sequencer/templates/steps/{step_template_id}/archive` | [`g8.api.sequences.archiveStepTemplate`](sequences.md#op-archivesteptemplate) | destructive |
|
|
2505
|
+
| GET | `/api/v1/sequences` | [`g8.api.sequences.listSequences`](sequences.md#op-listsequences) | read |
|
|
2506
|
+
| POST | `/api/v1/sequences` | [`g8.api.sequenceLifecycle.createSequence`](sequenceLifecycle.md#op-createsequence) or `g8.sequences.create()` | external |
|
|
2507
|
+
| POST | `/api/v1/sequences/generate-spintax` | [`g8.api.sequences.generateSequenceSpintax`](sequences.md#op-generatesequencespintax) | external |
|
|
2508
|
+
| DELETE | `/api/v1/sequences/{sequence_id}` | [`g8.api.sequenceLifecycle.deleteSequence`](sequenceLifecycle.md#op-deletesequence) or `g8.sequences.delete()` | destructive |
|
|
2509
|
+
| GET | `/api/v1/sequences/{sequence_id}` | [`g8.api.sequences.getSequence`](sequences.md#op-getsequence) or `g8.sequences.get()` | read |
|
|
2510
|
+
| PATCH | `/api/v1/sequences/{sequence_id}` | [`g8.api.sequenceLifecycle.updateSequence`](sequenceLifecycle.md#op-updatesequence) or `g8.sequences.update()` | external |
|
|
2511
|
+
| GET | `/api/v1/sequences/{sequence_id}/analytics` | [`g8.api.sequenceLifecycle.getSequenceAnalytics`](sequenceLifecycle.md#op-getsequenceanalytics) or `g8.sequences.analytics()` | read |
|
|
2512
|
+
| POST | `/api/v1/sequences/{sequence_id}/archive` | [`g8.api.sequences.archiveSequence`](sequences.md#op-archivesequence) | destructive |
|
|
2513
|
+
| DELETE | `/api/v1/sequences/{sequence_id}/campaign` | [`g8.api.sequences.unlinkSequenceCampaign`](sequences.md#op-unlinksequencecampaign) | destructive |
|
|
2514
|
+
| PUT | `/api/v1/sequences/{sequence_id}/campaign` | [`g8.api.sequences.linkSequenceCampaign`](sequences.md#op-linksequencecampaign) | write |
|
|
2515
|
+
| DELETE | `/api/v1/sequences/{sequence_id}/channels` | [`g8.api.sequences.removeSequenceChannels`](sequences.md#op-removesequencechannels) | destructive |
|
|
2516
|
+
| GET | `/api/v1/sequences/{sequence_id}/channels` | [`g8.api.sequences.listSequenceChannels`](sequences.md#op-listsequencechannels) | read |
|
|
2517
|
+
| POST | `/api/v1/sequences/{sequence_id}/channels` | [`g8.api.sequences.addSequenceChannels`](sequences.md#op-addsequencechannels) | write |
|
|
2518
|
+
| DELETE | `/api/v1/sequences/{sequence_id}/channels/linkedin` | [`g8.api.sequenceLifecycle.removeLinkedinChannel`](sequenceLifecycle.md#op-removelinkedinchannel) | destructive |
|
|
2519
|
+
| DELETE | `/api/v1/sequences/{sequence_id}/channels/{sequence_channel_id}` | [`g8.api.sequences.removeSequenceChannel`](sequences.md#op-removesequencechannel) | destructive |
|
|
2520
|
+
| GET | `/api/v1/sequences/{sequence_id}/contact-ids` | [`g8.api.sequences.listSequenceContactIds`](sequences.md#op-listsequencecontactids) | read |
|
|
2521
|
+
| GET | `/api/v1/sequences/{sequence_id}/contacts` | [`g8.api.sequences.listSequenceContacts`](sequences.md#op-listsequencecontacts) or `g8.sequences.contacts()` | read |
|
|
2522
|
+
| POST | `/api/v1/sequences/{sequence_id}/contacts` | [`g8.api.sequences.addContactsToSequence`](sequences.md#op-addcontactstosequence) or `g8.sequences.add()` | external |
|
|
2523
|
+
| POST | `/api/v1/sequences/{sequence_id}/contacts/{contact_id}/pause` | [`g8.api.sequences.pauseSequenceContact`](sequences.md#op-pausesequencecontact) | write |
|
|
2524
|
+
| POST | `/api/v1/sequences/{sequence_id}/contacts/{contact_id}/resume` | [`g8.api.sequences.resumeSequenceContact`](sequences.md#op-resumesequencecontact) | external |
|
|
2525
|
+
| POST | `/api/v1/sequences/{sequence_id}/duplicate` | [`g8.api.sequences.duplicateSequence`](sequences.md#op-duplicatesequence) | write |
|
|
2526
|
+
| POST | `/api/v1/sequences/{sequence_id}/pause` | [`g8.api.sequences.pauseSequence`](sequences.md#op-pausesequence) or `g8.sequences.pause()` | external |
|
|
2527
|
+
| GET | `/api/v1/sequences/{sequence_id}/preview` | [`g8.api.sequenceLifecycle.previewSequence`](sequenceLifecycle.md#op-previewsequence) or `g8.sequences.preview()` | read |
|
|
2528
|
+
| GET | `/api/v1/sequences/{sequence_id}/reports` | [`g8.api.sequences.getSequenceReports`](sequences.md#op-getsequencereports) | read |
|
|
2529
|
+
| POST | `/api/v1/sequences/{sequence_id}/resume` | [`g8.api.sequences.resumeSequence`](sequences.md#op-resumesequence) or `g8.sequences.resume()` | external |
|
|
2530
|
+
| GET | `/api/v1/sequences/{sequence_id}/routing-summary` | [`g8.api.sequences.getSequenceRoutingSummary`](sequences.md#op-getsequenceroutingsummary) | read |
|
|
2531
|
+
| POST | `/api/v1/sequences/{sequence_id}/run` | [`g8.api.sequences.runSequence`](sequences.md#op-runsequence) or `g8.sequences.run()` | external |
|
|
2532
|
+
| GET | `/api/v1/sequences/{sequence_id}/stats` | [`g8.api.sequences.getSequenceStats`](sequences.md#op-getsequencestats) | read |
|
|
2533
|
+
| POST | `/api/v1/sequences/{sequence_id}/status` | [`g8.api.sequences.setSequenceStatus`](sequences.md#op-setsequencestatus) | write |
|
|
2534
|
+
| GET | `/api/v1/sequences/{sequence_id}/steps` | [`g8.api.sequenceLifecycle.listSequenceSteps`](sequenceLifecycle.md#op-listsequencesteps) | read |
|
|
2535
|
+
| POST | `/api/v1/sequences/{sequence_id}/steps` | [`g8.api.sequences.addSequenceSteps`](sequences.md#op-addsequencesteps) | write |
|
|
2536
|
+
| DELETE | `/api/v1/sequences/{sequence_id}/steps/{step_id}` | [`g8.api.sequences.deleteSequenceStep`](sequences.md#op-deletesequencestep) | destructive |
|
|
2537
|
+
| PATCH | `/api/v1/sequences/{sequence_id}/steps/{step_id}` | [`g8.api.sequenceLifecycle.updateSequenceStep`](sequenceLifecycle.md#op-updatesequencestep) or `g8.sequences.updateStep()` | external |
|
|
2538
|
+
| POST | `/api/v1/sequences/{sequence_id}/sync` | [`g8.api.sequences.syncSequence`](sequences.md#op-syncsequence) | external |
|
|
2539
|
+
| POST | `/api/v1/sequences/{sequence_id}/terminate` | [`g8.api.sequences.terminateSequence`](sequences.md#op-terminatesequence) | write |
|
|
2540
|
+
| POST | `/api/v1/service-token` | [`g8.api.appPlatformTokens.issueServiceToken`](appPlatformTokens.md#op-issueservicetoken) | write |
|
|
2541
|
+
| GET | `/api/v1/settings/scrape-config` | [`g8.api.scraping.getScrapeConfig`](scraping.md#op-getscrapeconfig) | read |
|
|
2542
|
+
| PATCH | `/api/v1/settings/scrape-config` | [`g8.api.scraping.updateScrapeConfig`](scraping.md#op-updatescrapeconfig) | write |
|
|
2543
|
+
| POST | `/api/v1/settings/scrape-config/crawl` | [`g8.api.scraping.startFullSiteCrawl`](scraping.md#op-startfullsitecrawl) | external |
|
|
2544
|
+
| GET | `/api/v1/settings/scrape-config/crawl/status/{job_id}` | [`g8.api.scraping.getCrawlStatus`](scraping.md#op-getcrawlstatus) | read |
|
|
2545
|
+
| POST | `/api/v1/signatures/assignments` | [`g8.api.signatures.assignSignatureIdentity`](signatures.md#op-assignsignatureidentity) | write |
|
|
2546
|
+
| GET | `/api/v1/signatures/campaigns` | [`g8.api.signatures.listSignatureCampaigns`](signatures.md#op-listsignaturecampaigns) | read |
|
|
2547
|
+
| POST | `/api/v1/signatures/campaigns` | [`g8.api.signatures.createSignatureCampaign`](signatures.md#op-createsignaturecampaign) | write |
|
|
2548
|
+
| POST | `/api/v1/signatures/campaigns/preview` | [`g8.api.signatures.previewSignatureCampaign`](signatures.md#op-previewsignaturecampaign) | write |
|
|
2549
|
+
| PATCH | `/api/v1/signatures/campaigns/{campaign_id}` | [`g8.api.signatures.updateSignatureCampaign`](signatures.md#op-updatesignaturecampaign) | write |
|
|
2550
|
+
| GET | `/api/v1/signatures/mailboxes` | [`g8.api.signatures.listSignatureDeployments`](signatures.md#op-listsignaturedeployments) | read |
|
|
2551
|
+
| POST | `/api/v1/signatures/mailboxes/push` | [`g8.api.signatures.pushSignatures`](signatures.md#op-pushsignatures) | write |
|
|
2552
|
+
| POST | `/api/v1/signatures/mailboxes/{mailbox_id}/push` | [`g8.api.signatures.pushSignature`](signatures.md#op-pushsignature) | write |
|
|
2553
|
+
| POST | `/api/v1/signatures/mailboxes/{mailbox_id}/restore` | [`g8.api.signatures.restoreSignature`](signatures.md#op-restoresignature) | write |
|
|
2554
|
+
| POST | `/api/v1/signatures/mailboxes/{mailbox_id}/source` | [`g8.api.signatures.changeSignatureSource`](signatures.md#op-changesignaturesource) | write |
|
|
2555
|
+
| GET | `/api/v1/signatures/members` | [`g8.api.signatures.listSignatureMembers`](signatures.md#op-listsignaturemembers) | read |
|
|
2556
|
+
| POST | `/api/v1/signatures/preview` | [`g8.api.signatures.previewSignatureTemplate`](signatures.md#op-previewsignaturetemplate) | write |
|
|
2557
|
+
| GET | `/api/v1/signatures/reports` | [`g8.api.signatures.getSignatureReport`](signatures.md#op-getsignaturereport) | read |
|
|
2558
|
+
| GET | `/api/v1/signatures/settings` | [`g8.api.signatures.getSignatureSettings`](signatures.md#op-getsignaturesettings) | read |
|
|
2559
|
+
| PUT | `/api/v1/signatures/settings` | [`g8.api.signatures.updateSignatureSettings`](signatures.md#op-updatesignaturesettings) | write |
|
|
2560
|
+
| POST | `/api/v1/signatures/setup-preview` | [`g8.api.signatures.previewSignatureSetup`](signatures.md#op-previewsignaturesetup) | write |
|
|
2561
|
+
| GET | `/api/v1/signatures/templates` | [`g8.api.signatures.listSignatureTemplates`](signatures.md#op-listsignaturetemplates) | read |
|
|
2562
|
+
| POST | `/api/v1/signatures/templates` | [`g8.api.signatures.createSignatureTemplate`](signatures.md#op-createsignaturetemplate) | write |
|
|
2563
|
+
| DELETE | `/api/v1/signatures/templates/{template_id}` | [`g8.api.signatures.archiveSignatureTemplate`](signatures.md#op-archivesignaturetemplate) | destructive |
|
|
2564
|
+
| GET | `/api/v1/signatures/templates/{template_id}` | [`g8.api.signatures.getSignatureTemplate`](signatures.md#op-getsignaturetemplate) | read |
|
|
2565
|
+
| PATCH | `/api/v1/signatures/templates/{template_id}` | [`g8.api.signatures.updateSignatureTemplate`](signatures.md#op-updatesignaturetemplate) | write |
|
|
2566
|
+
| POST | `/api/v1/signatures/templates/{template_id}/assign` | [`g8.api.signatures.assignSignatureTemplate`](signatures.md#op-assignsignaturetemplate) | write |
|
|
2567
|
+
| POST | `/api/v1/signatures/templates/{template_id}/preview` | [`g8.api.signatures.previewSavedSignatureTemplate`](signatures.md#op-previewsavedsignaturetemplate) | write |
|
|
2568
|
+
| POST | `/api/v1/signatures/templates/{template_id}/set-default` | [`g8.api.signatures.setDefaultSignatureTemplate`](signatures.md#op-setdefaultsignaturetemplate) | write |
|
|
2569
|
+
| GET | `/api/v1/skills` | [`g8.api.skills.listSkills`](skills.md#op-listskills) or `g8.skills.list()` | read |
|
|
2570
|
+
| POST | `/api/v1/skills` | [`g8.api.skills.createSkill`](skills.md#op-createskill) or `g8.skills.createAPI()` | write |
|
|
2571
|
+
| POST | `/api/v1/skills/from-node` | [`g8.api.skills.createFromNode`](skills.md#op-createfromnode) or `g8.skills.createFromNode()` | write |
|
|
2572
|
+
| POST | `/api/v1/skills/from-template` | [`g8.api.skills.createFromTemplate`](skills.md#op-createfromtemplate) or `g8.skills.createFromTemplate()` | write |
|
|
2573
|
+
| POST | `/api/v1/skills/infer-variable` | [`g8.api.workflows.inferSkillVariable`](workflows.md#op-inferskillvariable) | write |
|
|
2574
|
+
| GET | `/api/v1/skills/models` | [`g8.api.skills.listModels`](skills.md#op-listmodels) or `g8.skills.listModels()` | read |
|
|
2575
|
+
| POST | `/api/v1/skills/parse-script-parameters` | [`g8.api.workflows.parseScriptParameters`](workflows.md#op-parsescriptparameters) | write |
|
|
2576
|
+
| POST | `/api/v1/skills/resolve-templates` | [`g8.api.workflows.resolveSkillTemplates`](workflows.md#op-resolveskilltemplates) | write |
|
|
2577
|
+
| GET | `/api/v1/skills/templates` | [`g8.api.skills.listTemplates`](skills.md#op-listtemplates) or `g8.skills.listTemplates()` | read |
|
|
2578
|
+
| POST | `/api/v1/skills/validate` | [`g8.api.skills.validateTemplate`](skills.md#op-validatetemplate) or `g8.skills.validate()` | write |
|
|
2579
|
+
| DELETE | `/api/v1/skills/{action_id}` | [`g8.api.skills.deleteSkill`](skills.md#op-deleteskill) or `g8.skills.delete()` | destructive |
|
|
2580
|
+
| GET | `/api/v1/skills/{action_id}` | [`g8.api.skills.getSkill`](skills.md#op-getskill) or `g8.skills.get()` | read |
|
|
2581
|
+
| PUT | `/api/v1/skills/{action_id}` | [`g8.api.skills.updateSkill`](skills.md#op-updateskill) or `g8.skills.updateAPI()` | write |
|
|
2582
|
+
| GET | `/api/v1/skills/{action_id}/collections` | [`g8.api.workflows.listSkillCollections`](workflows.md#op-listskillcollections) | read |
|
|
2583
|
+
| POST | `/api/v1/skills/{action_id}/collections` | [`g8.api.workflows.attachSkillCollections`](workflows.md#op-attachskillcollections) | write |
|
|
2584
|
+
| DELETE | `/api/v1/skills/{action_id}/collections/{collection_id}` | [`g8.api.workflows.detachSkillCollection`](workflows.md#op-detachskillcollection) | destructive |
|
|
2585
|
+
| POST | `/api/v1/skills/{action_id}/execute` | [`g8.api.skills.executeSkill`](skills.md#op-executeskill) or `g8.skills.execute()` | external |
|
|
2586
|
+
| POST | `/api/v1/skills/{action_id}/test` | [`g8.api.workflows.testSkillOnce`](workflows.md#op-testskillonce) | write |
|
|
2587
|
+
| GET | `/api/v1/skills/{action_id}/test-cases` | [`g8.api.workflows.listSkillTestCases`](workflows.md#op-listskilltestcases) | read |
|
|
2588
|
+
| POST | `/api/v1/skills/{action_id}/test-cases` | [`g8.api.workflows.createSkillTestCase`](workflows.md#op-createskilltestcase) | write |
|
|
2589
|
+
| DELETE | `/api/v1/skills/{action_id}/test-cases/{test_case_id}` | [`g8.api.workflows.deleteSkillTestCase`](workflows.md#op-deleteskilltestcase) | destructive |
|
|
2590
|
+
| PUT | `/api/v1/skills/{action_id}/test-cases/{test_case_id}` | [`g8.api.workflows.updateSkillTestCase`](workflows.md#op-updateskilltestcase) | write |
|
|
2591
|
+
| GET | `/api/v1/skills/{action_id}/test-runs` | [`g8.api.workflows.listSkillTestRuns`](workflows.md#op-listskilltestruns) | read |
|
|
2592
|
+
| POST | `/api/v1/skills/{action_id}/test-runs` | [`g8.api.workflows.runSkillTestSuite`](workflows.md#op-runskilltestsuite) | external |
|
|
2593
|
+
| GET | `/api/v1/skills/{action_id}/variables` | [`g8.api.skills.extractVariables`](skills.md#op-extractvariables) or `g8.skills.getVariables()` | read |
|
|
2594
|
+
| GET | `/api/v1/skills/{action_id}/versions` | [`g8.api.workflows.listSkillVersions`](workflows.md#op-listskillversions) | read |
|
|
2595
|
+
| GET | `/api/v1/skills/{action_id}/versions/{version_id}/diff` | [`g8.api.workflows.diffSkillVersions`](workflows.md#op-diffskillversions) | read |
|
|
2596
|
+
| POST | `/api/v1/skills/{action_id}/versions/{version_id}/restore` | [`g8.api.workflows.restoreSkillVersion`](workflows.md#op-restoreskillversion) | write |
|
|
2597
|
+
| GET | `/api/v1/sms/phone-numbers` | [`g8.api.channels.listSmsPhoneNumbers`](channels.md#op-listsmsphonenumbers) | read |
|
|
2598
|
+
| PUT | `/api/v1/sms/phone-numbers/{phone_number}` | [`g8.api.channels.updateSmsPhoneConfig`](channels.md#op-updatesmsphoneconfig) | external |
|
|
2599
|
+
| GET | `/api/v1/sms/phone-numbers/{phone_number}/config` | [`g8.api.channels.getSmsPhoneConfig`](channels.md#op-getsmsphoneconfig) | read |
|
|
2600
|
+
| GET | `/api/v1/snippet` | [`g8.api.snippet.getOrgSnippet`](snippet.md#op-getorgsnippet) or `g8.snippet.get()` | read |
|
|
2601
|
+
| GET | `/api/v1/snippet/form` | [`g8.api.snippet.getFormTemplate`](snippet.md#op-getformtemplate) | read |
|
|
2602
|
+
| GET | `/api/v1/social-listeners` | [`g8.api.signals.listListeners`](signals.md#op-listlisteners) | read |
|
|
2603
|
+
| POST | `/api/v1/social-listeners` | [`g8.api.signals.createListener`](signals.md#op-createlistener) | billable |
|
|
2604
|
+
| GET | `/api/v1/social-listeners/auto-seed-status` | [`g8.api.signals.getAutoSeedStatus`](signals.md#op-getautoseedstatus) | read |
|
|
2605
|
+
| POST | `/api/v1/social-listeners/auto-seed/all` | [`g8.api.signals.autoSeedAllListeners`](signals.md#op-autoseedalllisteners) | billable |
|
|
2606
|
+
| POST | `/api/v1/social-listeners/auto-seed/brand` | [`g8.api.signals.autoSeedBrandListener`](signals.md#op-autoseedbrandlistener) | billable |
|
|
2607
|
+
| POST | `/api/v1/social-listeners/auto-seed/competitors` | [`g8.api.signals.autoSeedCompetitorListeners`](signals.md#op-autoseedcompetitorlisteners) | billable |
|
|
2608
|
+
| POST | `/api/v1/social-listeners/auto-seed/engagement` | [`g8.api.signals.autoSeedEngagementListeners`](signals.md#op-autoseedengagementlisteners) | billable |
|
|
2609
|
+
| POST | `/api/v1/social-listeners/auto-seed/keywords` | [`g8.api.signals.autoSeedKeywordListeners`](signals.md#op-autoseedkeywordlisteners) | billable |
|
|
2610
|
+
| POST | `/api/v1/social-listeners/bulk-from-list` | [`g8.api.signals.bulkCreateListenersFromList`](signals.md#op-bulkcreatelistenersfromlist) | billable |
|
|
2611
|
+
| GET | `/api/v1/social-listeners/engagements/top-accounts` | [`g8.api.signals.listTopEngagedAccounts`](signals.md#op-listtopengagedaccounts) | read |
|
|
2612
|
+
| DELETE | `/api/v1/social-listeners/integrations/x` | [`g8.api.signals.disconnectXCredentials`](signals.md#op-disconnectxcredentials) | destructive |
|
|
2613
|
+
| GET | `/api/v1/social-listeners/integrations/x` | [`g8.api.signals.getXIntegration`](signals.md#op-getxintegration) | read |
|
|
2614
|
+
| POST | `/api/v1/social-listeners/integrations/x` | [`g8.api.signals.connectXCredentials`](signals.md#op-connectxcredentials) | billable |
|
|
2615
|
+
| GET | `/api/v1/social-listeners/integrations/x/mode` | [`g8.api.signals.getXEffectiveMode`](signals.md#op-getxeffectivemode) | read |
|
|
2616
|
+
| POST | `/api/v1/social-listeners/integrations/x/test` | [`g8.api.signals.testXCredentials`](signals.md#op-testxcredentials) | billable |
|
|
2617
|
+
| GET | `/api/v1/social-listeners/posts/by-contact/{contact_id}` | [`g8.api.signals.listPostsByContact`](signals.md#op-listpostsbycontact) | read |
|
|
2618
|
+
| POST | `/api/v1/social-listeners/posts/search` | [`g8.api.signals.searchMatchedPosts`](signals.md#op-searchmatchedposts) | read |
|
|
2619
|
+
| POST | `/api/v1/social-listeners/posts/{post_id}/add-to-sequence` | [`g8.api.signals.addPostAuthorToSequence`](signals.md#op-addpostauthortosequence) | external |
|
|
2620
|
+
| POST | `/api/v1/social-listeners/posts/{post_id}/engagements/add-to-list` | [`g8.api.signals.addEngagersToList`](signals.md#op-addengagerstolist) | billable |
|
|
2621
|
+
| POST | `/api/v1/social-listeners/posts/{post_id}/engagements/search` | [`g8.api.signals.searchPostEngagements`](signals.md#op-searchpostengagements) | read |
|
|
2622
|
+
| POST | `/api/v1/social-listeners/posts/{post_id}/mark` | [`g8.api.signals.markPost`](signals.md#op-markpost) | billable |
|
|
2623
|
+
| POST | `/api/v1/social-listeners/posts/{post_id}/save-contact` | [`g8.api.signals.savePostAuthorAsContact`](signals.md#op-savepostauthorascontact) | billable |
|
|
2624
|
+
| POST | `/api/v1/social-listeners/preview-cost` | [`g8.api.signals.previewListenerCost`](signals.md#op-previewlistenercost) | read |
|
|
2625
|
+
| POST | `/api/v1/social-listeners/queries/generate` | [`g8.api.signals.generateListenerQuery`](signals.md#op-generatelistenerquery) | billable |
|
|
2626
|
+
| GET | `/api/v1/social-listeners/settings` | [`g8.api.signals.getSocialSettings`](signals.md#op-getsocialsettings) | read |
|
|
2627
|
+
| PATCH | `/api/v1/social-listeners/settings` | [`g8.api.signals.updateSocialSettings`](signals.md#op-updatesocialsettings) | billable |
|
|
2628
|
+
| GET | `/api/v1/social-listeners/source-lists` | [`g8.api.signals.listSourceLists`](signals.md#op-listsourcelists) | read |
|
|
2629
|
+
| GET | `/api/v1/social-listeners/stats` | [`g8.api.signals.getSocialStats`](signals.md#op-getsocialstats) | read |
|
|
2630
|
+
| DELETE | `/api/v1/social-listeners/{listener_id}` | [`g8.api.signals.deleteListener`](signals.md#op-deletelistener) | destructive |
|
|
2631
|
+
| GET | `/api/v1/social-listeners/{listener_id}` | [`g8.api.signals.getListener`](signals.md#op-getlistener) | read |
|
|
2632
|
+
| PATCH | `/api/v1/social-listeners/{listener_id}` | [`g8.api.signals.updateListener`](signals.md#op-updatelistener) | billable |
|
|
2633
|
+
| GET | `/api/v1/social/accounts` | [`g8.api.socialPublishing.listSocialAccounts`](socialPublishing.md#op-listsocialaccounts) | read |
|
|
2634
|
+
| DELETE | `/api/v1/social/accounts/{account_id}` | [`g8.api.socialPublishing.disconnectSocialAccount`](socialPublishing.md#op-disconnectsocialaccount) | destructive |
|
|
2635
|
+
| GET | `/api/v1/social/analytics` | [`g8.api.socialPublishing.getSocialAnalytics`](socialPublishing.md#op-getsocialanalytics) | read |
|
|
2636
|
+
| GET | `/api/v1/social/autopilot/{account_id}` | [`g8.api.socialPublishing.getSocialAutopilot`](socialPublishing.md#op-getsocialautopilot) | read |
|
|
2637
|
+
| PUT | `/api/v1/social/autopilot/{account_id}` | [`g8.api.socialPublishing.saveSocialAutopilot`](socialPublishing.md#op-savesocialautopilot) | external |
|
|
2638
|
+
| POST | `/api/v1/social/autopilot/{account_id}/pause` | [`g8.api.socialPublishing.pauseSocialAutopilot`](socialPublishing.md#op-pausesocialautopilot) | write |
|
|
2639
|
+
| GET | `/api/v1/social/generate/context` | [`g8.api.socialPublishing.getSocialGenerationContext`](socialPublishing.md#op-getsocialgenerationcontext) | read |
|
|
2640
|
+
| GET | `/api/v1/social/ideas` | [`g8.api.socialPublishing.listSocialIdeas`](socialPublishing.md#op-listsocialideas) | read |
|
|
2641
|
+
| GET | `/api/v1/social/posts` | [`g8.api.socialPublishing.listSocialPosts`](socialPublishing.md#op-listsocialposts) | read |
|
|
2642
|
+
| POST | `/api/v1/social/posts` | [`g8.api.socialPublishing.createSocialPost`](socialPublishing.md#op-createsocialpost) | write |
|
|
2643
|
+
| POST | `/api/v1/social/posts/generate` | [`g8.api.socialPublishing.generateSocialPost`](socialPublishing.md#op-generatesocialpost) | billable |
|
|
2644
|
+
| DELETE | `/api/v1/social/posts/{post_id}` | [`g8.api.socialPublishing.deleteSocialPost`](socialPublishing.md#op-deletesocialpost) | destructive |
|
|
2645
|
+
| GET | `/api/v1/social/posts/{post_id}` | [`g8.api.socialPublishing.getSocialPost`](socialPublishing.md#op-getsocialpost) | read |
|
|
2646
|
+
| PATCH | `/api/v1/social/posts/{post_id}` | [`g8.api.socialPublishing.updateSocialPost`](socialPublishing.md#op-updatesocialpost) | write |
|
|
2647
|
+
| POST | `/api/v1/social/posts/{post_id}/cancel` | [`g8.api.socialPublishing.cancelSocialPost`](socialPublishing.md#op-cancelsocialpost) | destructive |
|
|
2648
|
+
| GET | `/api/v1/social/posts/{post_id}/engagers` | [`g8.api.socialPublishing.listSocialPostEngagers`](socialPublishing.md#op-listsocialpostengagers) | read |
|
|
2649
|
+
| POST | `/api/v1/social/posts/{post_id}/engagers/add-to-audience` | [`g8.api.socialPublishing.addSocialEngagersToAudience`](socialPublishing.md#op-addsocialengagerstoaudience) | external |
|
|
2650
|
+
| POST | `/api/v1/social/posts/{post_id}/engagers/enroll` | [`g8.api.socialPublishing.enrollSocialEngagers`](socialPublishing.md#op-enrollsocialengagers) | external |
|
|
2651
|
+
| GET | `/api/v1/social/posts/{post_id}/metrics` | [`g8.api.socialPublishing.getSocialPostMetrics`](socialPublishing.md#op-getsocialpostmetrics) | read |
|
|
2652
|
+
| POST | `/api/v1/social/posts/{post_id}/publish` | [`g8.api.socialPublishing.publishSocialPost`](socialPublishing.md#op-publishsocialpost) | external |
|
|
2653
|
+
| POST | `/api/v1/social/posts/{post_id}/schedule` | [`g8.api.socialPublishing.scheduleSocialPost`](socialPublishing.md#op-schedulesocialpost) | external |
|
|
2654
|
+
| GET | `/api/v1/social/providers` | [`g8.api.socialPublishing.listSocialProviders`](socialPublishing.md#op-listsocialproviders) | read |
|
|
2655
|
+
| POST | `/api/v1/stripe/api-key` | [`g8.api.quotes.connectStripeApiKey`](quotes.md#op-connectstripeapikey) | external |
|
|
2656
|
+
| GET | `/api/v1/stripe/companies/{company_id}/invoices` | [`g8.api.quotes.getCompanyStripeInvoices`](quotes.md#op-getcompanystripeinvoices) | read |
|
|
2657
|
+
| GET | `/api/v1/stripe/companies/{company_id}/revenue-summary` | [`g8.api.quotes.getCompanyRevenueSummary`](quotes.md#op-getcompanyrevenuesummary) | read |
|
|
2658
|
+
| GET | `/api/v1/stripe/companies/{company_id}/subscriptions` | [`g8.api.quotes.getCompanyStripeSubscriptions`](quotes.md#op-getcompanystripesubscriptions) | read |
|
|
2659
|
+
| GET | `/api/v1/stripe/connections/{connection_id}/data` | [`g8.api.quotes.getStripeData`](quotes.md#op-getstripedata) | read |
|
|
2660
|
+
| GET | `/api/v1/stripe/connections/{connection_id}/data/{resource}` | [`g8.api.quotes.getStripeDataPage`](quotes.md#op-getstripedatapage) | read |
|
|
2661
|
+
| PATCH | `/api/v1/stripe/customers/{customer_id}/mapping` | [`g8.api.quotes.updateStripeCustomerMapping`](quotes.md#op-updatestripecustomermapping) | write |
|
|
2662
|
+
| GET | `/api/v1/stripe/integration-status` | [`g8.api.quotes.getStripeIntegrationStatus`](quotes.md#op-getstripeintegrationstatus) | read |
|
|
2663
|
+
| GET | `/api/v1/stripe/product-settings` | [`g8.api.quotes.listStripeProductSettings`](quotes.md#op-liststripeproductsettings) | read |
|
|
2664
|
+
| PATCH | `/api/v1/stripe/product-settings/bulk` | [`g8.api.quotes.bulkUpdateStripeProductSettings`](quotes.md#op-bulkupdatestripeproductsettings) | write |
|
|
2665
|
+
| PUT | `/api/v1/stripe/product-settings/{stripe_product_id}` | [`g8.api.quotes.upsertStripeProductSettings`](quotes.md#op-upsertstripeproductsettings) | write |
|
|
2666
|
+
| GET | `/api/v1/stripe/products` | [`g8.api.quotes.listStripeProducts`](quotes.md#op-liststripeproducts) | read |
|
|
2667
|
+
| GET | `/api/v1/stripe/products/{product_id}/subscribers` | [`g8.api.quotes.listStripeProductSubscribers`](quotes.md#op-liststripeproductsubscribers) | read |
|
|
2668
|
+
| POST | `/api/v1/stripe/sync` | [`g8.api.quotes.triggerStripeSync`](quotes.md#op-triggerstripesync) | external |
|
|
2669
|
+
| POST | `/api/v1/style/normalize` | [`g8.api.studioDocuments.normalizeTextToStyle`](studioDocuments.md#op-normalizetexttostyle) | write |
|
|
2670
|
+
| GET | `/api/v1/style/rules` | [`g8.api.studioDocuments.getStyleRules`](studioDocuments.md#op-getstylerules) | read |
|
|
2671
|
+
| POST | `/api/v1/support/contact` | [`g8.api.support.contactSupport`](support.md#op-contactsupport) | write |
|
|
2672
|
+
| DELETE | `/api/v1/tam` | [`g8.api.gtmLibrary.deleteTam`](gtmLibrary.md#op-deletetam) | destructive |
|
|
2673
|
+
| GET | `/api/v1/tam` | [`g8.api.gtmLibrary.getTam`](gtmLibrary.md#op-gettam) | read |
|
|
2674
|
+
| PATCH | `/api/v1/tam` | [`g8.api.gtmLibrary.updateTam`](gtmLibrary.md#op-updatetam) | write |
|
|
2675
|
+
| POST | `/api/v1/tam/generate` | [`g8.api.gtmLibrary.generateTam`](gtmLibrary.md#op-generatetam) | billable |
|
|
2676
|
+
| POST | `/api/v1/tam/regenerate` | [`g8.api.gtmLibrary.regenerateTam`](gtmLibrary.md#op-regeneratetam) | billable |
|
|
2677
|
+
| GET | `/api/v1/tasks` | [`g8.api.tasks.listAllTasks`](tasks.md#op-listalltasks) or `g8.tasks.list()` | read |
|
|
2678
|
+
| POST | `/api/v1/tasks` | [`g8.api.tasks.createGlobalTask`](tasks.md#op-createglobaltask) | write |
|
|
2679
|
+
| GET | `/api/v1/tasks/records/{entity_type}/{entity_id}` | [`g8.api.tasks.getTaskRecord`](tasks.md#op-gettaskrecord) | read |
|
|
2680
|
+
| DELETE | `/api/v1/tasks/replies/{reply_id}` | [`g8.api.tasks.deleteTaskReply`](tasks.md#op-deletetaskreply) | destructive |
|
|
2681
|
+
| PUT | `/api/v1/tasks/replies/{reply_id}` | [`g8.api.tasks.updateTaskReply`](tasks.md#op-updatetaskreply) | write |
|
|
2682
|
+
| GET | `/api/v1/tasks/settings` | [`g8.api.tasks.getTaskSettings`](tasks.md#op-gettasksettings) | read |
|
|
2683
|
+
| PUT | `/api/v1/tasks/settings` | [`g8.api.tasks.updateTaskSettings`](tasks.md#op-updatetasksettings) | write |
|
|
2684
|
+
| DELETE | `/api/v1/tasks/{task_id}` | [`g8.api.tasks.deleteTask`](tasks.md#op-deletetask) or `g8.tasks.delete()` | destructive |
|
|
2685
|
+
| GET | `/api/v1/tasks/{task_id}` | [`g8.api.tasks.getTask`](tasks.md#op-gettask) | read |
|
|
2686
|
+
| PATCH | `/api/v1/tasks/{task_id}` | [`g8.api.tasks.updateTask`](tasks.md#op-updatetask) or `g8.tasks.update()` | write |
|
|
2687
|
+
| PUT | `/api/v1/tasks/{task_id}/assignment` | [`g8.api.tasks.assignTaskExecutor`](tasks.md#op-assigntaskexecutor) | write |
|
|
2688
|
+
| POST | `/api/v1/tasks/{task_id}/copies` | [`g8.api.tasks.createTaskCopies`](tasks.md#op-createtaskcopies) | write |
|
|
2689
|
+
| GET | `/api/v1/tasks/{task_id}/execution` | [`g8.api.tasks.taskExecutionHistory`](tasks.md#op-taskexecutionhistory) | read |
|
|
2690
|
+
| GET | `/api/v1/tasks/{task_id}/replies` | [`g8.api.tasks.listTaskReplies`](tasks.md#op-listtaskreplies) | read |
|
|
2691
|
+
| POST | `/api/v1/tasks/{task_id}/replies` | [`g8.api.tasks.createTaskReply`](tasks.md#op-createtaskreply) | write |
|
|
2692
|
+
| DELETE | `/api/v1/tasks/{task_id}/resolve` | [`g8.api.tasks.reopenTaskThread`](tasks.md#op-reopentaskthread) | destructive |
|
|
2693
|
+
| POST | `/api/v1/tasks/{task_id}/resolve` | [`g8.api.tasks.resolveTaskThread`](tasks.md#op-resolvetaskthread) | write |
|
|
2694
|
+
| POST | `/api/v1/tasks/{task_id}/snooze` | [`g8.api.tasks.snoozeTaskReminder`](tasks.md#op-snoozetaskreminder) | write |
|
|
2695
|
+
| POST | `/api/v1/tasks/{task_id}/start` | [`g8.api.tasks.startTaskExecution`](tasks.md#op-starttaskexecution) | billable |
|
|
2696
|
+
| GET | `/api/v1/tasks/{task_id}/subtasks` | [`g8.api.tasks.listSubtasks`](tasks.md#op-listsubtasks) | read |
|
|
2697
|
+
| POST | `/api/v1/tasks/{task_id}/subtasks` | [`g8.api.tasks.createSubtask`](tasks.md#op-createsubtask) | write |
|
|
2698
|
+
| DELETE | `/api/v1/tasks/{task_id}/subtasks/{subtask_id}` | [`g8.api.tasks.deleteSubtask`](tasks.md#op-deletesubtask) | destructive |
|
|
2699
|
+
| PUT | `/api/v1/tasks/{task_id}/subtasks/{subtask_id}` | [`g8.api.tasks.updateSubtask`](tasks.md#op-updatesubtask) | write |
|
|
2700
|
+
| GET | `/api/v1/team-members` | [`g8.api.teamMembers.listTeamMembers`](teamMembers.md#op-listteammembers) | read |
|
|
2701
|
+
| POST | `/api/v1/team-members` | [`g8.api.teamMembers.createTeamMember`](teamMembers.md#op-createteammember) | write |
|
|
2702
|
+
| GET | `/api/v1/team-members/me` | [`g8.api.teamMembers.getMyTeamMember`](teamMembers.md#op-getmyteammember) | read |
|
|
2703
|
+
| PATCH | `/api/v1/team-members/me` | [`g8.api.teamMembers.updateMyTeamMember`](teamMembers.md#op-updatemyteammember) | write |
|
|
2704
|
+
| POST | `/api/v1/team-members/me/enrich-linkedin` | [`g8.api.teamMembers.enrichMyProfileFromLinkedin`](teamMembers.md#op-enrichmyprofilefromlinkedin) | billable |
|
|
2705
|
+
| POST | `/api/v1/team-members/me/import-social` | [`g8.api.teamMembers.importMySocialProfile`](teamMembers.md#op-importmysocialprofile) | write |
|
|
2706
|
+
| POST | `/api/v1/team-members/me/sync-desktop-profile` | [`g8.api.teamMembers.syncMyDesktopProfile`](teamMembers.md#op-syncmydesktopprofile) | write |
|
|
2707
|
+
| POST | `/api/v1/team-members/sync` | [`g8.api.teamMembers.syncTeamMembers`](teamMembers.md#op-syncteammembers) | external |
|
|
2708
|
+
| DELETE | `/api/v1/team-members/{team_member_id}` | [`g8.api.teamMembers.deleteTeamMember`](teamMembers.md#op-deleteteammember) | destructive |
|
|
2709
|
+
| GET | `/api/v1/team-members/{team_member_id}` | [`g8.api.teamMembers.getTeamMember`](teamMembers.md#op-getteammember) | read |
|
|
2710
|
+
| PATCH | `/api/v1/team-members/{team_member_id}` | [`g8.api.teamMembers.updateTeamMember`](teamMembers.md#op-updateteammember) | write |
|
|
2711
|
+
| POST | `/api/v1/team-members/{team_member_id}/clone` | [`g8.api.teamMembers.cloneTeamMember`](teamMembers.md#op-cloneteammember) | write |
|
|
2712
|
+
| GET | `/api/v1/team-members/{team_member_id}/companies` | [`g8.api.teamMembers.getTeamMemberCompanies`](teamMembers.md#op-getteammembercompanies) | read |
|
|
2713
|
+
| GET | `/api/v1/team-members/{team_member_id}/content` | [`g8.api.teamMembers.getTeamMemberContent`](teamMembers.md#op-getteammembercontent) | read |
|
|
2714
|
+
| GET | `/api/v1/team-members/{team_member_id}/deals` | [`g8.api.teamMembers.getTeamMemberDeals`](teamMembers.md#op-getteammemberdeals) | read |
|
|
2715
|
+
| POST | `/api/v1/team-members/{team_member_id}/enrich-linkedin` | [`g8.api.teamMembers.enrichTeamMemberFromLinkedin`](teamMembers.md#op-enrichteammemberfromlinkedin) | billable |
|
|
2716
|
+
| POST | `/api/v1/team-members/{team_member_id}/generate-post` | [`g8.api.teamMembers.generateMemberPost`](teamMembers.md#op-generatememberpost) | billable |
|
|
2717
|
+
| GET | `/api/v1/team-members/{team_member_id}/notes` | [`g8.api.teamMembers.listTeamMemberNotes`](teamMembers.md#op-listteammembernotes) | read |
|
|
2718
|
+
| POST | `/api/v1/team-members/{team_member_id}/notes` | [`g8.api.teamMembers.createTeamMemberNote`](teamMembers.md#op-createteammembernote) | write |
|
|
2719
|
+
| DELETE | `/api/v1/team-members/{team_member_id}/notes/{note_id}` | [`g8.api.teamMembers.deleteTeamMemberNote`](teamMembers.md#op-deleteteammembernote) | destructive |
|
|
2720
|
+
| PUT | `/api/v1/team-members/{team_member_id}/notes/{note_id}` | [`g8.api.teamMembers.updateTeamMemberNote`](teamMembers.md#op-updateteammembernote) | write |
|
|
2721
|
+
| GET | `/api/v1/teams` | [`g8.api.teams.listTeams`](teams.md#op-listteams) | read |
|
|
2722
|
+
| POST | `/api/v1/teams` | [`g8.api.teams.createTeam`](teams.md#op-createteam) | write |
|
|
2723
|
+
| POST | `/api/v1/teams/auto-compose/suggest` | [`g8.api.teams.autoComposeSuggest`](teams.md#op-autocomposesuggest) | billable |
|
|
2724
|
+
| GET | `/api/v1/teams/available/agents` | [`g8.api.teams.listAvailableAgents`](teams.md#op-listavailableagents) | read |
|
|
2725
|
+
| GET | `/api/v1/teams/available/campaigns` | [`g8.api.teams.listAvailableCampaigns`](teams.md#op-listavailablecampaigns) | read |
|
|
2726
|
+
| GET | `/api/v1/teams/available/chatbots` | [`g8.api.teams.listAvailableChatbots`](teams.md#op-listavailablechatbots) | read |
|
|
2727
|
+
| GET | `/api/v1/teams/available/linkedin-accounts` | [`g8.api.teams.listAvailableLinkedinAccounts`](teams.md#op-listavailablelinkedinaccounts) | read |
|
|
2728
|
+
| GET | `/api/v1/teams/available/mailboxes` | [`g8.api.teams.listAvailableMailboxes`](teams.md#op-listavailablemailboxes) | read |
|
|
2729
|
+
| GET | `/api/v1/teams/available/phone-numbers` | [`g8.api.teams.listAvailablePhoneNumbers`](teams.md#op-listavailablephonenumbers) | read |
|
|
2730
|
+
| GET | `/api/v1/teams/available/sequences` | [`g8.api.teams.listAvailableSequences`](teams.md#op-listavailablesequences) | read |
|
|
2731
|
+
| DELETE | `/api/v1/teams/{team_id}` | [`g8.api.teams.deleteTeam`](teams.md#op-deleteteam) | destructive |
|
|
2732
|
+
| GET | `/api/v1/teams/{team_id}` | [`g8.api.teams.getTeam`](teams.md#op-getteam) | read |
|
|
2733
|
+
| PUT | `/api/v1/teams/{team_id}` | [`g8.api.teams.updateTeam`](teams.md#op-updateteam) | write |
|
|
2734
|
+
| GET | `/api/v1/teams/{team_id}/agents` | [`g8.api.teams.listTeamAgents`](teams.md#op-listteamagents) | read |
|
|
2735
|
+
| POST | `/api/v1/teams/{team_id}/agents` | [`g8.api.teams.addTeamAgent`](teams.md#op-addteamagent) | write |
|
|
2736
|
+
| DELETE | `/api/v1/teams/{team_id}/agents/{user_id}` | [`g8.api.teams.removeTeamAgent`](teams.md#op-removeteamagent) | destructive |
|
|
2737
|
+
| PATCH | `/api/v1/teams/{team_id}/agents/{user_id}` | [`g8.api.teams.updateTeamAgentRole`](teams.md#op-updateteamagentrole) | destructive |
|
|
2738
|
+
| GET | `/api/v1/teams/{team_id}/campaigns` | [`g8.api.teams.listTeamCampaigns`](teams.md#op-listteamcampaigns) | read |
|
|
2739
|
+
| POST | `/api/v1/teams/{team_id}/campaigns` | [`g8.api.teams.assignCampaignToTeam`](teams.md#op-assigncampaigntoteam) | write |
|
|
2740
|
+
| DELETE | `/api/v1/teams/{team_id}/campaigns/{campaign_id}` | [`g8.api.teams.unassignCampaignFromTeam`](teams.md#op-unassigncampaignfromteam) | destructive |
|
|
2741
|
+
| GET | `/api/v1/teams/{team_id}/chatbots` | [`g8.api.teams.listTeamChatbots`](teams.md#op-listteamchatbots) | read |
|
|
2742
|
+
| GET | `/api/v1/teams/{team_id}/linkedin-accounts` | [`g8.api.teams.listTeamLinkedinAccounts`](teams.md#op-listteamlinkedinaccounts) | read |
|
|
2743
|
+
| POST | `/api/v1/teams/{team_id}/linkedin-accounts` | [`g8.api.teams.assignLinkedinAccountToTeam`](teams.md#op-assignlinkedinaccounttoteam) | write |
|
|
2744
|
+
| DELETE | `/api/v1/teams/{team_id}/linkedin-accounts/assoc/{assoc_id}` | [`g8.api.teams.unassignLinkedinAccountByAssoc`](teams.md#op-unassignlinkedinaccountbyassoc) | destructive |
|
|
2745
|
+
| DELETE | `/api/v1/teams/{team_id}/linkedin-accounts/{linkedin_account_id}` | [`g8.api.teams.unassignLinkedinAccountFromTeam`](teams.md#op-unassignlinkedinaccountfromteam) | destructive |
|
|
2746
|
+
| GET | `/api/v1/teams/{team_id}/mailboxes` | [`g8.api.teams.listTeamMailboxes`](teams.md#op-listteammailboxes) | read |
|
|
2747
|
+
| POST | `/api/v1/teams/{team_id}/mailboxes` | [`g8.api.teams.assignMailboxToTeam`](teams.md#op-assignmailboxtoteam) | write |
|
|
2748
|
+
| DELETE | `/api/v1/teams/{team_id}/mailboxes/{mailbox_id}` | [`g8.api.teams.unassignMailboxFromTeam`](teams.md#op-unassignmailboxfromteam) | destructive |
|
|
2749
|
+
| POST | `/api/v1/teams/{team_id}/members` | [`g8.api.teams.addTeamMember`](teams.md#op-addteammember) | write |
|
|
2750
|
+
| DELETE | `/api/v1/teams/{team_id}/members/{user_id}` | [`g8.api.teams.removeTeamMember`](teams.md#op-removeteammember) | destructive |
|
|
2751
|
+
| PUT | `/api/v1/teams/{team_id}/members/{user_id}` | [`g8.api.teams.updateTeamMemberRole`](teams.md#op-updateteammemberrole) | destructive |
|
|
2752
|
+
| GET | `/api/v1/teams/{team_id}/phone-numbers` | [`g8.api.teams.listTeamPhoneNumbers`](teams.md#op-listteamphonenumbers) | read |
|
|
2753
|
+
| POST | `/api/v1/teams/{team_id}/phone-numbers` | [`g8.api.teams.assignPhoneToTeam`](teams.md#op-assignphonetoteam) | write |
|
|
2754
|
+
| DELETE | `/api/v1/teams/{team_id}/phone-numbers/{phone_id}` | [`g8.api.teams.unassignPhoneFromTeam`](teams.md#op-unassignphonefromteam) | destructive |
|
|
2755
|
+
| GET | `/api/v1/teams/{team_id}/sequences` | [`g8.api.teams.listTeamSequences`](teams.md#op-listteamsequences) | read |
|
|
2756
|
+
| POST | `/api/v1/universal-activity` | [`g8.api.inbox.queryUniversalActivity`](inbox.md#op-queryuniversalactivity) | write |
|
|
2757
|
+
| GET | `/api/v1/universal-activity/metrics` | [`g8.api.inbox.getUniversalActivityMetrics`](inbox.md#op-getuniversalactivitymetrics) | read |
|
|
2758
|
+
| GET | `/api/v1/universal-activity/preview/{event_id}` | [`g8.api.inbox.getUniversalActivityPreview`](inbox.md#op-getuniversalactivitypreview) | read |
|
|
2759
|
+
| GET | `/api/v1/universal-activity/queues` | [`g8.api.inbox.listUniversalActivityQueues`](inbox.md#op-listuniversalactivityqueues) | read |
|
|
2760
|
+
| POST | `/api/v1/universal-activity/save-view` | [`g8.api.inbox.createUniversalActivitySavedView`](inbox.md#op-createuniversalactivitysavedview) | write |
|
|
2761
|
+
| GET | `/api/v1/universal-activity/saved-views` | [`g8.api.inbox.listUniversalActivitySavedViews`](inbox.md#op-listuniversalactivitysavedviews) | read |
|
|
2762
|
+
| GET | `/api/v1/usage` | [`g8.api.usage.getUsage`](usage.md#op-getusage) | read |
|
|
2763
|
+
| GET | `/api/v1/usage/holds` | [`g8.api.usage.getCreditHolds`](usage.md#op-getcreditholds) | read |
|
|
2764
|
+
| GET | `/api/v1/usage/pricing/domains/{tld}` | [`g8.api.usage.getDomainPricing`](usage.md#op-getdomainpricing) | read |
|
|
2765
|
+
| GET | `/api/v1/usage/pricing/llm` | [`g8.api.usage.getLlmPricing`](usage.md#op-getllmpricing) | read |
|
|
2766
|
+
| GET | `/api/v1/usage/subscription` | [`g8.api.usage.getSubscriptionStatus`](usage.md#op-getsubscriptionstatus) | read |
|
|
2767
|
+
| GET | `/api/v1/usage/transactions` | [`g8.api.usage.listUsageTransactions`](usage.md#op-listusagetransactions) | read |
|
|
2768
|
+
| GET | `/api/v1/visitors/ads/events` | [`g8.api.visitors.listAdVisitorEvents`](visitors.md#op-listadvisitorevents) | read |
|
|
2769
|
+
| GET | `/api/v1/visitors/campaigns/events` | [`g8.api.visitors.listCampaignVisitorEvents`](visitors.md#op-listcampaignvisitorevents) | read |
|
|
2770
|
+
| POST | `/api/v1/visitors/campaigns/list-syncs` | [`g8.api.visitors.startCampaignListSync`](visitors.md#op-startcampaignlistsync) | write |
|
|
2771
|
+
| GET | `/api/v1/visitors/campaigns/list-syncs/{job_id}` | [`g8.api.visitors.getCampaignListSync`](visitors.md#op-getcampaignlistsync) | read |
|
|
2772
|
+
| GET | `/api/v1/visitors/client-info` | [`g8.api.visitors.getTrackingClientInfo`](visitors.md#op-gettrackingclientinfo) | read |
|
|
2773
|
+
| GET | `/api/v1/visitors/companies/events` | [`g8.api.visitors.listCompanyVisitorEvents`](visitors.md#op-listcompanyvisitorevents) | read |
|
|
2774
|
+
| GET | `/api/v1/visitors/contacts-metrics` | [`g8.api.visitors.getVisitorContactMetrics`](visitors.md#op-getvisitorcontactmetrics) | read |
|
|
2775
|
+
| GET | `/api/v1/visitors/contacts/b2bc/events` | [`g8.api.visitors.listB2bcContactVisitorEvents`](visitors.md#op-listb2bccontactvisitorevents) | read |
|
|
2776
|
+
| GET | `/api/v1/visitors/contacts/events` | [`g8.api.visitors.listContactVisitorEvents`](visitors.md#op-listcontactvisitorevents) | read |
|
|
2777
|
+
| GET | `/api/v1/visitors/contacts/{contact_id}/events` | [`g8.api.visitors.getContactVisitorEvents`](visitors.md#op-getcontactvisitorevents) | read |
|
|
2778
|
+
| GET | `/api/v1/visitors/form-capture-settings` | [`g8.api.visitors.getFormCaptureSettings`](visitors.md#op-getformcapturesettings) | read |
|
|
2779
|
+
| PATCH | `/api/v1/visitors/form-capture-settings` | [`g8.api.visitors.updateFormCaptureSettings`](visitors.md#op-updateformcapturesettings) | write |
|
|
2780
|
+
| GET | `/api/v1/visitors/installation-check` | [`g8.api.visitors.checkTrackingInstallation`](visitors.md#op-checktrackinginstallation) | read |
|
|
2781
|
+
| POST | `/api/v1/visitors/links/build` | [`g8.api.visitors.buildTrackedLink`](visitors.md#op-buildtrackedlink) | write |
|
|
2782
|
+
| GET | `/api/v1/visitors/links/events` | [`g8.api.visitors.listLinkVisitorEvents`](visitors.md#op-listlinkvisitorevents) | read |
|
|
2783
|
+
| GET | `/api/v1/visitors/live` | [`g8.api.visitors.getLiveVisitors`](visitors.md#op-getlivevisitors) | read |
|
|
2784
|
+
| GET | `/api/v1/visitors/live/aggregated` | [`g8.api.visitors.getAggregatedLiveVisitors`](visitors.md#op-getaggregatedlivevisitors) | read |
|
|
2785
|
+
| GET | `/api/v1/visitors/page-hosts` | [`g8.api.visitors.listVisitorPageHosts`](visitors.md#op-listvisitorpagehosts) | read |
|
|
2786
|
+
| GET | `/api/v1/visitors/streams` | [`g8.api.visitors.getVisitorWorkspace`](visitors.md#op-getvisitorworkspace) | read |
|
|
2787
|
+
| GET | `/api/v1/visitors/streams/list` | [`g8.api.visitors.listVisitorStreams`](visitors.md#op-listvisitorstreams) | read |
|
|
2788
|
+
| GET | `/api/v1/visitors/tailor/query-param-sets` | [`g8.api.visitors.listTailorQueryParamSets`](visitors.md#op-listtailorqueryparamsets) | read |
|
|
2789
|
+
| POST | `/api/v1/visitors/tailor/query-param-sets` | [`g8.api.visitors.createTailorQueryParamSet`](visitors.md#op-createtailorqueryparamset) | write |
|
|
2790
|
+
| DELETE | `/api/v1/visitors/tailor/query-param-sets/{set_id}` | [`g8.api.visitors.deleteTailorQueryParamSet`](visitors.md#op-deletetailorqueryparamset) | destructive |
|
|
2791
|
+
| GET | `/api/v1/visitors/{resource}/distinct-browsers` | [`g8.api.visitors.listVisitorDistinctBrowsers`](visitors.md#op-listvisitordistinctbrowsers) | read |
|
|
2792
|
+
| GET | `/api/v1/visitors/{resource}/distinct-utms` | [`g8.api.visitors.listVisitorDistinctUtms`](visitors.md#op-listvisitordistinctutms) | read |
|
|
2793
|
+
| POST | `/api/v1/visitors/{resource}/statistics` | [`g8.api.visitors.getVisitorStatistics`](visitors.md#op-getvisitorstatistics) | write |
|
|
2794
|
+
| DELETE | `/api/v1/voice/agent-documents/{document_id}` | [`g8.api.voice.deleteAgentDocument`](voice.md#op-deleteagentdocument) | destructive |
|
|
2795
|
+
| GET | `/api/v1/voice/agent-phone-numbers` | [`g8.api.voice.listAgentPhoneNumbers`](voice.md#op-listagentphonenumbers) | read |
|
|
2796
|
+
| GET | `/api/v1/voice/agent-templates` | [`g8.api.voice.listAgentTemplates`](voice.md#op-listagenttemplates) | read |
|
|
2797
|
+
| GET | `/api/v1/voice/agents` | [`g8.api.voice.listVoiceAgents`](voice.md#op-listvoiceagents) | read |
|
|
2798
|
+
| POST | `/api/v1/voice/agents` | [`g8.api.voice.createVoiceAgent`](voice.md#op-createvoiceagent) | write |
|
|
2799
|
+
| POST | `/api/v1/voice/agents/clone` | [`g8.api.voice.cloneAgent`](voice.md#op-cloneagent) | write |
|
|
2800
|
+
| GET | `/api/v1/voice/agents/defaults` | [`g8.api.voice.getAgentDefaults`](voice.md#op-getagentdefaults) | read |
|
|
2801
|
+
| GET | `/api/v1/voice/agents/global-settings` | [`g8.api.voice.getAgentGlobalSettings`](voice.md#op-getagentglobalsettings) | read |
|
|
2802
|
+
| POST | `/api/v1/voice/agents/global-settings` | [`g8.api.voice.setAgentGlobalSettings`](voice.md#op-setagentglobalsettings) | write |
|
|
2803
|
+
| PATCH | `/api/v1/voice/agents/receptionist` | [`g8.api.voice.toggleReceptionistAgent`](voice.md#op-togglereceptionistagent) | write |
|
|
2804
|
+
| POST | `/api/v1/voice/agents/receptionist` | [`g8.api.voice.ensureReceptionistAgent`](voice.md#op-ensurereceptionistagent) | write |
|
|
2805
|
+
| DELETE | `/api/v1/voice/agents/{agent_id}` | [`g8.api.voice.deleteVoiceAgent`](voice.md#op-deletevoiceagent) | destructive |
|
|
2806
|
+
| GET | `/api/v1/voice/agents/{agent_id}` | [`g8.api.voice.getVoiceAgent`](voice.md#op-getvoiceagent) | read |
|
|
2807
|
+
| PUT | `/api/v1/voice/agents/{agent_id}` | [`g8.api.voice.updateVoiceAgent`](voice.md#op-updatevoiceagent) | write |
|
|
2808
|
+
| GET | `/api/v1/voice/agents/{agent_id}/activity` | [`g8.api.voice.getAgentActivity`](voice.md#op-getagentactivity) | read |
|
|
2809
|
+
| GET | `/api/v1/voice/agents/{agent_id}/documents` | [`g8.api.voice.listAgentDocuments`](voice.md#op-listagentdocuments) | read |
|
|
2810
|
+
| POST | `/api/v1/voice/agents/{agent_id}/documents/search` | [`g8.api.voice.searchAgentDocuments`](voice.md#op-searchagentdocuments) | read |
|
|
2811
|
+
| POST | `/api/v1/voice/agents/{agent_id}/documents/upload` | [`g8.api.voice.uploadAgentDocuments`](voice.md#op-uploadagentdocuments) | billable |
|
|
2812
|
+
| POST | `/api/v1/voice/agents/{agent_id}/memory` | [`g8.api.voice.updateAgentMemory`](voice.md#op-updateagentmemory) | write |
|
|
2813
|
+
| POST | `/api/v1/voice/agents/{agent_id}/save-as-template` | [`g8.api.voice.saveAgentAsTemplate`](voice.md#op-saveagentastemplate) | write |
|
|
2814
|
+
| GET | `/api/v1/voice/agents/{agent_id}/skill-stats` | [`g8.api.voice.getAgentSkillStats`](voice.md#op-getagentskillstats) | read |
|
|
2815
|
+
| GET | `/api/v1/voice/agents/{agent_id}/skills` | [`g8.api.voice.listAgentSkills`](voice.md#op-listagentskills) | read |
|
|
2816
|
+
| POST | `/api/v1/voice/agents/{agent_id}/skills` | [`g8.api.voice.attachSkillsToAgent`](voice.md#op-attachskillstoagent) | write |
|
|
2817
|
+
| DELETE | `/api/v1/voice/agents/{agent_id}/skills/{action_id}` | [`g8.api.voice.detachSkillFromAgent`](voice.md#op-detachskillfromagent) | destructive |
|
|
2818
|
+
| POST | `/api/v1/voice/agents/{agent_id}/test` | [`g8.api.voice.runAgentTest`](voice.md#op-runagenttest) | write |
|
|
2819
|
+
| GET | `/api/v1/voice/agents/{agent_id}/test-cases` | [`g8.api.voice.listAgentTestCases`](voice.md#op-listagenttestcases) | read |
|
|
2820
|
+
| POST | `/api/v1/voice/agents/{agent_id}/test-cases` | [`g8.api.voice.createAgentTestCase`](voice.md#op-createagenttestcase) | write |
|
|
2821
|
+
| DELETE | `/api/v1/voice/agents/{agent_id}/test-cases/{test_case_id}` | [`g8.api.voice.deleteAgentTestCase`](voice.md#op-deleteagenttestcase) | destructive |
|
|
2822
|
+
| PUT | `/api/v1/voice/agents/{agent_id}/test-cases/{test_case_id}` | [`g8.api.voice.updateAgentTestCase`](voice.md#op-updateagenttestcase) | write |
|
|
2823
|
+
| GET | `/api/v1/voice/agents/{agent_id}/test-runs` | [`g8.api.voice.listAgentTestRuns`](voice.md#op-listagenttestruns) | read |
|
|
2824
|
+
| GET | `/api/v1/voice/agents/{agent_id}/test-suite-status` | [`g8.api.voice.getAgentTestSuiteStatus`](voice.md#op-getagenttestsuitestatus) | read |
|
|
2825
|
+
| POST | `/api/v1/voice/agents/{agent_id}/test/run-all` | [`g8.api.voice.runAllAgentTests`](voice.md#op-runallagenttests) | write |
|
|
2826
|
+
| POST | `/api/v1/voice/call-flow-examples/transcribe` | [`g8.api.voice.transcribeCallFlowExample`](voice.md#op-transcribecallflowexample) | billable |
|
|
2827
|
+
| GET | `/api/v1/voice/call-results/campaigns` | [`g8.api.voice.listCallResultCampaigns`](voice.md#op-listcallresultcampaigns) | read |
|
|
2828
|
+
| GET | `/api/v1/voice/call-results/inbound` | [`g8.api.voice.listInboundCallResults`](voice.md#op-listinboundcallresults) | read |
|
|
2829
|
+
| POST | `/api/v1/voice/call-results/search` | [`g8.api.voice.searchCallResults`](voice.md#op-searchcallresults) | read |
|
|
2830
|
+
| POST | `/api/v1/voice/call-scripts/generate` | [`g8.api.voice.generateCallScript`](voice.md#op-generatecallscript) | billable |
|
|
2831
|
+
| POST | `/api/v1/voice/calls` | [`g8.api.voice.startVoiceCall`](voice.md#op-startvoicecall) | external |
|
|
2832
|
+
| GET | `/api/v1/voice/calls/{call_id}/artifacts` | [`g8.api.voice.getCallArtifacts`](voice.md#op-getcallartifacts) | read |
|
|
2833
|
+
| GET | `/api/v1/voice/calls/{call_id}/historical-recording` | [`g8.api.voice.downloadHistoricalCallRecording`](voice.md#op-downloadhistoricalcallrecording) | read |
|
|
2834
|
+
| GET | `/api/v1/voice/calls/{call_id}/recording` | [`g8.api.voice.downloadCallRecording`](voice.md#op-downloadcallrecording) | read |
|
|
2835
|
+
| GET | `/api/v1/voice/campaigns/call-scripts` | [`g8.api.voice.generateCampaignCallScripts`](voice.md#op-generatecampaigncallscripts) | billable |
|
|
2836
|
+
| POST | `/api/v1/voice/campaigns/call-scripts` | [`g8.api.voice.generateCampaignCallScript`](voice.md#op-generatecampaigncallscript) | billable |
|
|
2837
|
+
| POST | `/api/v1/voice/campaigns/email-enhancements` | [`g8.api.voice.enhanceCampaignEmail`](voice.md#op-enhancecampaignemail) | billable |
|
|
2838
|
+
| POST | `/api/v1/voice/campaigns/email-estimate` | [`g8.api.voice.estimateCampaignEmail`](voice.md#op-estimatecampaignemail) | read |
|
|
2839
|
+
| GET | `/api/v1/voice/campaigns/email-models` | [`g8.api.voice.listCampaignEmailModels`](voice.md#op-listcampaignemailmodels) | read |
|
|
2840
|
+
| POST | `/api/v1/voice/campaigns/email-spintax` | [`g8.api.voice.generateEmailSpintax`](voice.md#op-generateemailspintax) | billable |
|
|
2841
|
+
| GET | `/api/v1/voice/campaigns/email-templates` | [`g8.api.voice.generateCampaignEmails`](voice.md#op-generatecampaignemails) | billable |
|
|
2842
|
+
| POST | `/api/v1/voice/campaigns/emails` | [`g8.api.voice.generateCampaignEmail`](voice.md#op-generatecampaignemail) | billable |
|
|
2843
|
+
| POST | `/api/v1/voice/campaigns/linkedin-messages` | [`g8.api.voice.generateLinkedinMessage`](voice.md#op-generatelinkedinmessage) | billable |
|
|
2844
|
+
| POST | `/api/v1/voice/campaigns/memory` | [`g8.api.voice.storeCampaignMemory`](voice.md#op-storecampaignmemory) | write |
|
|
2845
|
+
| POST | `/api/v1/voice/campaigns/onboarding/messages` | [`g8.api.voice.sendOnboardingMessage`](voice.md#op-sendonboardingmessage) | billable |
|
|
2846
|
+
| DELETE | `/api/v1/voice/campaigns/onboarding/threads` | [`g8.api.voice.deleteOnboardingThread`](voice.md#op-deleteonboardingthread) | destructive |
|
|
2847
|
+
| GET | `/api/v1/voice/campaigns/onboarding/threads` | [`g8.api.voice.listOnboardingThreads`](voice.md#op-listonboardingthreads) | read |
|
|
2848
|
+
| POST | `/api/v1/voice/campaigns/onboarding/threads` | [`g8.api.voice.createOnboardingThread`](voice.md#op-createonboardingthread) | write |
|
|
2849
|
+
| POST | `/api/v1/voice/campaigns/onboarding/threads/actions` | [`g8.api.voice.runOnboardingThreadAction`](voice.md#op-runonboardingthreadaction) | billable |
|
|
2850
|
+
| GET | `/api/v1/voice/campaigns/onboarding/threads/{thread_id}` | [`g8.api.voice.getOnboardingThread`](voice.md#op-getonboardingthread) | read |
|
|
2851
|
+
| GET | `/api/v1/voice/campaigns/past-conversation` | [`g8.api.voice.getPastConversation`](voice.md#op-getpastconversation) | read |
|
|
2852
|
+
| GET | `/api/v1/voice/campaigns/past-conversations` | [`g8.api.voice.listPastConversations`](voice.md#op-listpastconversations) | read |
|
|
2853
|
+
| GET | `/api/v1/voice/campaigns/templates` | [`g8.api.voice.generateCampaignTemplate`](voice.md#op-generatecampaigntemplate) | billable |
|
|
2854
|
+
| POST | `/api/v1/voice/campaigns/voicemails` | [`g8.api.voice.generatePersonalisedVoicemail`](voice.md#op-generatepersonalisedvoicemail) | billable |
|
|
2855
|
+
| POST | `/api/v1/voice/chat-agent/conversations` | [`g8.api.voice.listChatAgentConversations`](voice.md#op-listchatagentconversations) | read |
|
|
2856
|
+
| DELETE | `/api/v1/voice/chat-agent/conversations/{chat_id}` | [`g8.api.voice.deleteChatAgentConversation`](voice.md#op-deletechatagentconversation) | destructive |
|
|
2857
|
+
| PUT | `/api/v1/voice/chat-agent/conversations/{chat_id}/name` | [`g8.api.voice.renameChatAgentConversation`](voice.md#op-renamechatagentconversation) | write |
|
|
2858
|
+
| POST | `/api/v1/voice/chat-agent/conversations/{chat_id}/transfer-to-human` | [`g8.api.voice.transferChatAgentConversation`](voice.md#op-transferchatagentconversation) | write |
|
|
2859
|
+
| POST | `/api/v1/voice/chat-agent/history` | [`g8.api.voice.getChatAgentHistory`](voice.md#op-getchatagenthistory) | read |
|
|
2860
|
+
| POST | `/api/v1/voice/chat-agent/messages` | [`g8.api.voice.sendChatAgentMessage`](voice.md#op-sendchatagentmessage) | billable |
|
|
2861
|
+
| POST | `/api/v1/voice/chats/search` | [`g8.api.voice.searchChats`](voice.md#op-searchchats) | read |
|
|
2862
|
+
| GET | `/api/v1/voice/collections` | [`g8.api.voice.listCollections`](voice.md#op-listcollections) | read |
|
|
2863
|
+
| POST | `/api/v1/voice/collections` | [`g8.api.voice.createCollection`](voice.md#op-createcollection) | write |
|
|
2864
|
+
| GET | `/api/v1/voice/collections/files` | [`g8.api.voice.listAllCollectionFiles`](voice.md#op-listallcollectionfiles) | read |
|
|
2865
|
+
| POST | `/api/v1/voice/collections/search` | [`g8.api.voice.searchCollections`](voice.md#op-searchcollections) | read |
|
|
2866
|
+
| DELETE | `/api/v1/voice/collections/{collection_id}` | [`g8.api.voice.deleteCollection`](voice.md#op-deletecollection) | destructive |
|
|
2867
|
+
| GET | `/api/v1/voice/collections/{collection_id}` | [`g8.api.voice.getCollection`](voice.md#op-getcollection) | read |
|
|
2868
|
+
| PUT | `/api/v1/voice/collections/{collection_id}` | [`g8.api.voice.updateCollection`](voice.md#op-updatecollection) | write |
|
|
2869
|
+
| DELETE | `/api/v1/voice/collections/{collection_id}/files` | [`g8.api.voice.deleteCollectionFile`](voice.md#op-deletecollectionfile) | destructive |
|
|
2870
|
+
| DELETE | `/api/v1/voice/collections/{collection_id}/files/all` | [`g8.api.voice.deleteAllCollectionFiles`](voice.md#op-deleteallcollectionfiles) | destructive |
|
|
2871
|
+
| GET | `/api/v1/voice/collections/{collection_id}/files/download-url` | [`g8.api.voice.getCollectionFileDownloadUrl`](voice.md#op-getcollectionfiledownloadurl) | read |
|
|
2872
|
+
| GET | `/api/v1/voice/collections/{collection_id}/files/exists` | [`g8.api.voice.checkCollectionFileExists`](voice.md#op-checkcollectionfileexists) | read |
|
|
2873
|
+
| POST | `/api/v1/voice/collections/{collection_id}/files/paste-text` | [`g8.api.voice.pasteTextIntoCollection`](voice.md#op-pastetextintocollection) | billable |
|
|
2874
|
+
| PUT | `/api/v1/voice/collections/{collection_id}/files/rename` | [`g8.api.voice.renameCollectionFile`](voice.md#op-renamecollectionfile) | write |
|
|
2875
|
+
| POST | `/api/v1/voice/collections/{collection_id}/files/upload` | [`g8.api.voice.uploadCollectionFile`](voice.md#op-uploadcollectionfile) | billable |
|
|
2876
|
+
| POST | `/api/v1/voice/collections/{collection_id}/files/upload-multiple` | [`g8.api.voice.uploadCollectionFiles`](voice.md#op-uploadcollectionfiles) | billable |
|
|
2877
|
+
| DELETE | `/api/v1/voice/collections/{collection_id}/folders` | [`g8.api.voice.deleteCollectionFolder`](voice.md#op-deletecollectionfolder) | destructive |
|
|
2878
|
+
| POST | `/api/v1/voice/collections/{collection_id}/folders` | [`g8.api.voice.createCollectionFolder`](voice.md#op-createcollectionfolder) | write |
|
|
2879
|
+
| POST | `/api/v1/voice/collections/{collection_id}/reindex` | [`g8.api.voice.reindexCollection`](voice.md#op-reindexcollection) | billable |
|
|
2880
|
+
| GET | `/api/v1/voice/collections/{collection_id}/scrape-sources` | [`g8.api.voice.listScrapeSources`](voice.md#op-listscrapesources) | read |
|
|
2881
|
+
| POST | `/api/v1/voice/collections/{collection_id}/scrape-sources` | [`g8.api.voice.createScrapeSource`](voice.md#op-createscrapesource) | billable |
|
|
2882
|
+
| DELETE | `/api/v1/voice/collections/{collection_id}/scrape-sources/{source_id}` | [`g8.api.voice.deleteScrapeSource`](voice.md#op-deletescrapesource) | destructive |
|
|
2883
|
+
| PATCH | `/api/v1/voice/collections/{collection_id}/scrape-sources/{source_id}` | [`g8.api.voice.updateScrapeSource`](voice.md#op-updatescrapesource) | write |
|
|
2884
|
+
| POST | `/api/v1/voice/collections/{collection_id}/scrape-sources/{source_id}/run` | [`g8.api.voice.runScrapeSource`](voice.md#op-runscrapesource) | billable |
|
|
2885
|
+
| GET | `/api/v1/voice/collections/{collection_id}/stats` | [`g8.api.voice.getCollectionStats`](voice.md#op-getcollectionstats) | read |
|
|
2886
|
+
| POST | `/api/v1/voice/collections/{collection_id}/sync` | [`g8.api.voice.syncCollection`](voice.md#op-synccollection) | write |
|
|
2887
|
+
| GET | `/api/v1/voice/collections/{collection_id}/vector-status` | [`g8.api.voice.getCollectionVectorStatus`](voice.md#op-getcollectionvectorstatus) | read |
|
|
2888
|
+
| DELETE | `/api/v1/voice/collections/{collection_id}/vectors` | [`g8.api.voice.clearCollectionVectors`](voice.md#op-clearcollectionvectors) | destructive |
|
|
2889
|
+
| GET | `/api/v1/voice/company-knowledge` | [`g8.api.voice.getCompanyKnowledge`](voice.md#op-getcompanyknowledge) | read |
|
|
2890
|
+
| POST | `/api/v1/voice/company-knowledge` | [`g8.api.voice.createCompanyKnowledge`](voice.md#op-createcompanyknowledge) | write |
|
|
2891
|
+
| PUT | `/api/v1/voice/company-knowledge` | [`g8.api.voice.updateCompanyKnowledge`](voice.md#op-updatecompanyknowledge) | write |
|
|
2892
|
+
| GET | `/api/v1/voice/company-knowledge/formatted` | [`g8.api.voice.getFormattedCompanyKnowledge`](voice.md#op-getformattedcompanyknowledge) | read |
|
|
2893
|
+
| GET | `/api/v1/voice/dialer/agents` | [`g8.api.voice.listDialerAgents`](voice.md#op-listdialeragents) or `g8.voice.dialer.agents()` | read |
|
|
2894
|
+
| GET | `/api/v1/voice/dialer/calls` | [`g8.api.voice.listCallsForContact`](voice.md#op-listcallsforcontact) or `g8.voice.dialer.listCalls()` | read |
|
|
2895
|
+
| GET | `/api/v1/voice/dialer/calls/{room_name}/grading` | [`g8.api.voice.getCallGrading`](voice.md#op-getcallgrading) or `g8.voice.dialer.callGrading()` | read |
|
|
2896
|
+
| GET | `/api/v1/voice/dialer/calls/{room_name}/transcript` | [`g8.api.voice.getCallTranscript`](voice.md#op-getcalltranscript) or `g8.voice.dialer.callTranscript()` | read |
|
|
2897
|
+
| GET | `/api/v1/voice/dialer/missed-callbacks` | [`g8.api.voice.listMissedCallbacks`](voice.md#op-listmissedcallbacks) or `g8.voice.dialer.missedCallbacks()` | read |
|
|
2898
|
+
| GET | `/api/v1/voice/dialer/numbers` | [`g8.api.voice.listDialerNumbers`](voice.md#op-listdialernumbers) or `g8.voice.dialer.numbers()` | read |
|
|
2899
|
+
| GET | `/api/v1/voice/dialer/sessions` | [`g8.api.voice.listDialerSessions`](voice.md#op-listdialersessions) or `g8.voice.dialer.listSessions()` | read |
|
|
2900
|
+
| POST | `/api/v1/voice/dialer/sessions` | [`g8.api.voice.createDialerSession`](voice.md#op-createdialersession) or `g8.voice.dialer.createSession()` | external |
|
|
2901
|
+
| POST | `/api/v1/voice/dialer/sessions/{session_id}/resume` | [`g8.api.voice.resumeDialerSession`](voice.md#op-resumedialersession) or `g8.voice.dialer.resumeSession()` | external |
|
|
2902
|
+
| PATCH | `/api/v1/voice/dialer/sessions/{session_id}/status` | [`g8.api.voice.updateDialerSessionStatus`](voice.md#op-updatedialersessionstatus) or `g8.voice.dialer.updateSessionStatus()` | external |
|
|
2903
|
+
| GET | `/api/v1/voice/dialer/stats` | [`g8.api.voice.getDialerStats`](voice.md#op-getdialerstats) or `g8.voice.dialer.stats()` | read |
|
|
2904
|
+
| GET | `/api/v1/voice/dispositions` | [`g8.api.voice.listVoiceDispositions`](voice.md#op-listvoicedispositions) | read |
|
|
2905
|
+
| POST | `/api/v1/voice/dispositions` | [`g8.api.voice.createVoiceDisposition`](voice.md#op-createvoicedisposition) | external |
|
|
2906
|
+
| PATCH | `/api/v1/voice/dispositions/{disposition_id}` | [`g8.api.voice.updateVoiceDisposition`](voice.md#op-updatevoicedisposition) | external |
|
|
2907
|
+
| POST | `/api/v1/voice/email-agent/batch` | [`g8.api.voice.batchEmailAgent`](voice.md#op-batchemailagent) | billable |
|
|
2908
|
+
| POST | `/api/v1/voice/email-agent/compose` | [`g8.api.voice.composeEmail`](voice.md#op-composeemail) | billable |
|
|
2909
|
+
| POST | `/api/v1/voice/email-agent/draft-reply` | [`g8.api.voice.draftEmailReply`](voice.md#op-draftemailreply) | billable |
|
|
2910
|
+
| POST | `/api/v1/voice/icp/queries` | [`g8.api.voice.generateIcpQueries`](voice.md#op-generateicpqueries) | billable |
|
|
2911
|
+
| POST | `/api/v1/voice/inbound-calls/decline` | [`g8.api.voice.declineInboundCall`](voice.md#op-declineinboundcall) | external |
|
|
2912
|
+
| POST | `/api/v1/voice/inbound-calls/dialer/{call_id}/decline` | [`g8.api.voice.declineDialerInboundCall`](voice.md#op-declinedialerinboundcall) | external |
|
|
2913
|
+
| GET | `/api/v1/voice/inbound-calls/pending` | [`g8.api.voice.listPendingInboundCalls`](voice.md#op-listpendinginboundcalls) | read |
|
|
2914
|
+
| POST | `/api/v1/voice/inbound-calls/{room_name}/claim` | [`g8.api.voice.claimInboundCall`](voice.md#op-claiminboundcall) | external |
|
|
2915
|
+
| DELETE | `/api/v1/voice/inbound-routing/business-hours` | [`g8.api.voice.deleteBusinessHours`](voice.md#op-deletebusinesshours) | destructive |
|
|
2916
|
+
| GET | `/api/v1/voice/inbound-routing/business-hours` | [`g8.api.voice.getBusinessHours`](voice.md#op-getbusinesshours) | read |
|
|
2917
|
+
| PUT | `/api/v1/voice/inbound-routing/business-hours` | [`g8.api.voice.upsertBusinessHours`](voice.md#op-upsertbusinesshours) | write |
|
|
2918
|
+
| GET | `/api/v1/voice/inbound-routing/rules` | [`g8.api.voice.listInboundRoutes`](voice.md#op-listinboundroutes) | read |
|
|
2919
|
+
| POST | `/api/v1/voice/inbound-routing/rules` | [`g8.api.voice.createInboundRoute`](voice.md#op-createinboundroute) | write |
|
|
2920
|
+
| DELETE | `/api/v1/voice/inbound-routing/rules/{route_id}` | [`g8.api.voice.deleteInboundRoute`](voice.md#op-deleteinboundroute) | destructive |
|
|
2921
|
+
| PATCH | `/api/v1/voice/inbound-routing/rules/{route_id}` | [`g8.api.voice.updateInboundRoute`](voice.md#op-updateinboundroute) | write |
|
|
2922
|
+
| DELETE | `/api/v1/voice/jobs/{job_id}` | [`g8.api.voice.deleteJob`](voice.md#op-deletejob) | destructive |
|
|
2923
|
+
| GET | `/api/v1/voice/jobs/{job_id}` | [`g8.api.voice.getJob`](voice.md#op-getjob) | read |
|
|
2924
|
+
| DELETE | `/api/v1/voice/knowledge-base/files` | [`g8.api.voice.deleteKnowledgeBaseFile`](voice.md#op-deleteknowledgebasefile) | destructive |
|
|
2925
|
+
| GET | `/api/v1/voice/knowledge-base/files` | [`g8.api.voice.listKnowledgeBaseFiles`](voice.md#op-listknowledgebasefiles) | read |
|
|
2926
|
+
| GET | `/api/v1/voice/knowledge-base/files/download` | [`g8.api.voice.downloadKnowledgeBaseFile`](voice.md#op-downloadknowledgebasefile) | read |
|
|
2927
|
+
| PUT | `/api/v1/voice/knowledge-base/files/rename` | [`g8.api.voice.renameKnowledgeBaseFile`](voice.md#op-renameknowledgebasefile) | write |
|
|
2928
|
+
| POST | `/api/v1/voice/knowledge-base/files/upload` | [`g8.api.voice.uploadKnowledgeBaseFile`](voice.md#op-uploadknowledgebasefile) | billable |
|
|
2929
|
+
| POST | `/api/v1/voice/mcp-servers` | [`g8.api.voice.createMcpServer`](voice.md#op-createmcpserver) | write |
|
|
2930
|
+
| DELETE | `/api/v1/voice/mcp-servers/{mcp_server_id}` | [`g8.api.voice.deleteMcpServer`](voice.md#op-deletemcpserver) | destructive |
|
|
2931
|
+
| PUT | `/api/v1/voice/mcp-servers/{mcp_server_id}` | [`g8.api.voice.updateMcpServer`](voice.md#op-updatemcpserver) | write |
|
|
2932
|
+
| POST | `/api/v1/voice/mcp-servers/{mcp_server_id}/test` | [`g8.api.voice.testMcpServer`](voice.md#op-testmcpserver) | external |
|
|
2933
|
+
| GET | `/api/v1/voice/mcp-servers/{mcp_server_id}/tools` | [`g8.api.voice.listMcpServerTools`](voice.md#op-listmcpservertools) | external |
|
|
2934
|
+
| GET | `/api/v1/voice/mcp-servers/{mcp_server_id}/tools/cached` | [`g8.api.voice.getCachedMcpTools`](voice.md#op-getcachedmcptools) | read |
|
|
2935
|
+
| DELETE | `/api/v1/voice/numbers` | [`g8.api.phoneNumbers.deleteVoiceNumber`](phoneNumbers.md#op-deletevoicenumber) | destructive |
|
|
2936
|
+
| GET | `/api/v1/voice/numbers/answering-agent` | [`g8.api.phoneNumbers.getVoiceAnsweringAgent`](phoneNumbers.md#op-getvoiceansweringagent) | read |
|
|
2937
|
+
| PATCH | `/api/v1/voice/numbers/assignee` | [`g8.api.phoneNumbers.updateVoiceAssignee`](phoneNumbers.md#op-updatevoiceassignee) | write |
|
|
2938
|
+
| DELETE | `/api/v1/voice/numbers/daily-counts` | [`g8.api.phoneNumbers.resetVoiceDailyCounts`](phoneNumbers.md#op-resetvoicedailycounts) | destructive |
|
|
2939
|
+
| PATCH | `/api/v1/voice/numbers/inbound-type` | [`g8.api.phoneNumbers.updateVoiceInboundType`](phoneNumbers.md#op-updatevoiceinboundtype) | write |
|
|
2940
|
+
| POST | `/api/v1/voice/numbers/provision` | [`g8.api.phoneNumbers.provisionVoiceNumber`](phoneNumbers.md#op-provisionvoicenumber) | write |
|
|
2941
|
+
| POST | `/api/v1/voice/numbers/verify-caller-id/{phone_number}` | [`g8.api.phoneNumbers.verifyVoiceCallerId`](phoneNumbers.md#op-verifyvoicecallerid) | write |
|
|
2942
|
+
| GET | `/api/v1/voice/phone-directory` | [`g8.api.voice.listPhoneDirectory`](voice.md#op-listphonedirectory) | read |
|
|
2943
|
+
| POST | `/api/v1/voice/phone-directory` | [`g8.api.voice.createPhoneDirectoryEntry`](voice.md#op-createphonedirectoryentry) | write |
|
|
2944
|
+
| GET | `/api/v1/voice/phone-directory/departments/{department}` | [`g8.api.voice.listDepartmentColleagues`](voice.md#op-listdepartmentcolleagues) | read |
|
|
2945
|
+
| GET | `/api/v1/voice/phone-directory/reachable` | [`g8.api.voice.listReachableColleagues`](voice.md#op-listreachablecolleagues) | read |
|
|
2946
|
+
| DELETE | `/api/v1/voice/phone-directory/{entry_id}` | [`g8.api.voice.deletePhoneDirectoryEntry`](voice.md#op-deletephonedirectoryentry) | destructive |
|
|
2947
|
+
| PUT | `/api/v1/voice/phone-directory/{entry_id}` | [`g8.api.voice.updatePhoneDirectoryEntry`](voice.md#op-updatephonedirectoryentry) | write |
|
|
2948
|
+
| POST | `/api/v1/voice/receptionist/messages` | [`g8.api.voice.sendReceptionistMessage`](voice.md#op-sendreceptionistmessage) | billable |
|
|
2949
|
+
| GET | `/api/v1/voice/research/business-data` | [`g8.api.voice.researchBusinessData`](voice.md#op-researchbusinessdata) | billable |
|
|
2950
|
+
| POST | `/api/v1/voice/research/company` | [`g8.api.voice.researchCompany`](voice.md#op-researchcompany) | billable |
|
|
2951
|
+
| GET | `/api/v1/voice/research/competitors` | [`g8.api.voice.researchCompetitors`](voice.md#op-researchcompetitors) | billable |
|
|
2952
|
+
| GET | `/api/v1/voice/research/faq` | [`g8.api.voice.researchFaq`](voice.md#op-researchfaq) | billable |
|
|
2953
|
+
| GET | `/api/v1/voice/research/keywords` | [`g8.api.voice.researchKeywords`](voice.md#op-researchkeywords) | billable |
|
|
2954
|
+
| POST | `/api/v1/voice/research/org-chart` | [`g8.api.voice.researchOrgChart`](voice.md#op-researchorgchart) | billable |
|
|
2955
|
+
| GET | `/api/v1/voice/research/prospect-company` | [`g8.api.voice.researchProspectCompany`](voice.md#op-researchprospectcompany) | billable |
|
|
2956
|
+
| POST | `/api/v1/voice/research/prospect-data` | [`g8.api.voice.researchProspectData`](voice.md#op-researchprospectdata) | billable |
|
|
2957
|
+
| POST | `/api/v1/voice/research/prospect-profile` | [`g8.api.voice.researchProspectProfile`](voice.md#op-researchprospectprofile) | billable |
|
|
2958
|
+
| POST | `/api/v1/voice/topics/classify` | [`g8.api.voice.classifyTopics`](voice.md#op-classifytopics) | billable |
|
|
2959
|
+
| GET | `/api/v1/voice/twins` | [`g8.api.voice.listTwins`](voice.md#op-listtwins) | read |
|
|
2960
|
+
| POST | `/api/v1/voice/twins` | [`g8.api.voice.createTwin`](voice.md#op-createtwin) | billable |
|
|
2961
|
+
| POST | `/api/v1/voice/twins/extract-linkedin` | [`g8.api.voice.extractTwinLinkedinProfile`](voice.md#op-extracttwinlinkedinprofile) | billable |
|
|
2962
|
+
| GET | `/api/v1/voice/twins/files/download` | [`g8.api.voice.downloadTwinFile`](voice.md#op-downloadtwinfile) | read |
|
|
2963
|
+
| DELETE | `/api/v1/voice/twins/{agent_id}` | [`g8.api.voice.deleteTwin`](voice.md#op-deletetwin) | destructive |
|
|
2964
|
+
| GET | `/api/v1/voice/twins/{agent_id}` | [`g8.api.voice.getTwin`](voice.md#op-gettwin) | read |
|
|
2965
|
+
| PUT | `/api/v1/voice/twins/{agent_id}` | [`g8.api.voice.updateTwin`](voice.md#op-updatetwin) | write |
|
|
2966
|
+
| DELETE | `/api/v1/voice/video-recordings` | [`g8.api.voice.bulkDeleteVideoRecordings`](voice.md#op-bulkdeletevideorecordings) | destructive |
|
|
2967
|
+
| GET | `/api/v1/voice/video-recordings` | [`g8.api.voice.listVideoRecordings`](voice.md#op-listvideorecordings) | read |
|
|
2968
|
+
| POST | `/api/v1/voice/video-recordings/upload` | [`g8.api.voice.uploadVideoRecording`](voice.md#op-uploadvideorecording) | billable |
|
|
2969
|
+
| DELETE | `/api/v1/voice/video-recordings/{video_id}` | [`g8.api.voice.deleteVideoRecording`](voice.md#op-deletevideorecording) | destructive |
|
|
2970
|
+
| GET | `/api/v1/voice/video-recordings/{video_id}` | [`g8.api.voice.getVideoRecording`](voice.md#op-getvideorecording) | read |
|
|
2971
|
+
| GET | `/api/v1/voice/video-recordings/{video_id}/url` | [`g8.api.voice.getVideoRecordingUrl`](voice.md#op-getvideorecordingurl) | read |
|
|
2972
|
+
| POST | `/api/v1/voice/voice-library/onboarding-voice` | [`g8.api.voice.setOnboardingVoice`](voice.md#op-setonboardingvoice) | billable |
|
|
2973
|
+
| GET | `/api/v1/voice/voice-library/presets` | [`g8.api.voice.listPresetVoices`](voice.md#op-listpresetvoices) | read |
|
|
2974
|
+
| GET | `/api/v1/voice/voice-library/voices` | [`g8.api.voice.listClonedVoices`](voice.md#op-listclonedvoices) | read |
|
|
2975
|
+
| POST | `/api/v1/voice/voice-library/voices` | [`g8.api.voice.cloneVoice`](voice.md#op-clonevoice) | billable |
|
|
2976
|
+
| GET | `/api/v1/voice/voicemails` | [`g8.api.voice.listVoicemails`](voice.md#op-listvoicemails) | read |
|
|
2977
|
+
| PATCH | `/api/v1/voice/voicemails/read-all` | [`g8.api.voice.markAllVoicemailsRead`](voice.md#op-markallvoicemailsread) | write |
|
|
2978
|
+
| PATCH | `/api/v1/voice/voicemails/{voicemail_id}/read` | [`g8.api.voice.markVoicemailRead`](voice.md#op-markvoicemailread) | write |
|
|
2979
|
+
| POST | `/api/v1/voice/worksheets/calculate` | [`g8.api.voice.calculateWorksheet`](voice.md#op-calculateworksheet) | billable |
|
|
2980
|
+
| POST | `/api/v1/warmup/setup` | [`g8.api.mailboxes.setupWarmup`](mailboxes.md#op-setupwarmup) | write |
|
|
2981
|
+
| DELETE | `/api/v1/warmup/{mailbox_id}` | [`g8.api.mailboxes.deleteWarmup`](mailboxes.md#op-deletewarmup) | destructive |
|
|
2982
|
+
| GET | `/api/v1/warmup/{mailbox_id}/analytics` | [`g8.api.mailboxes.getWarmupAnalytics`](mailboxes.md#op-getwarmupanalytics) | read |
|
|
2983
|
+
| POST | `/api/v1/warmup/{mailbox_id}/disable` | [`g8.api.mailboxes.disableWarmup`](mailboxes.md#op-disablewarmup) | write |
|
|
2984
|
+
| POST | `/api/v1/warmup/{mailbox_id}/enable` | [`g8.api.mailboxes.enableWarmup`](mailboxes.md#op-enablewarmup) | write |
|
|
2985
|
+
| PATCH | `/api/v1/warmup/{mailbox_id}/settings` | [`g8.api.mailboxes.updateWarmupSettings`](mailboxes.md#op-updatewarmupsettings) | write |
|
|
2986
|
+
| GET | `/api/v1/webchat/agents` | [`g8.api.webChat.listWebchatAgents`](webChat.md#op-listwebchatagents) | read |
|
|
2987
|
+
| POST | `/api/v1/webchat/agents` | [`g8.api.webChat.createWebchatAgent`](webChat.md#op-createwebchatagent) | write |
|
|
2988
|
+
| DELETE | `/api/v1/webchat/agents/{agent_id}` | [`g8.api.webChat.deleteWebchatAgent`](webChat.md#op-deletewebchatagent) | destructive |
|
|
2989
|
+
| PATCH | `/api/v1/webchat/agents/{agent_id}` | [`g8.api.webChat.updateWebchatAgent`](webChat.md#op-updatewebchatagent) | write |
|
|
2990
|
+
| GET | `/api/v1/webchat/assessments` | [`g8.api.webChat.listAssessments`](webChat.md#op-listassessments) | read |
|
|
2991
|
+
| POST | `/api/v1/webchat/assessments` | [`g8.api.webChat.createAssessment`](webChat.md#op-createassessment) | write |
|
|
2992
|
+
| DELETE | `/api/v1/webchat/assessments/{assessment_id}` | [`g8.api.webChat.deleteAssessment`](webChat.md#op-deleteassessment) | destructive |
|
|
2993
|
+
| GET | `/api/v1/webchat/assessments/{assessment_id}` | [`g8.api.webChat.getAssessment`](webChat.md#op-getassessment) | read |
|
|
2994
|
+
| PATCH | `/api/v1/webchat/assessments/{assessment_id}` | [`g8.api.webChat.updateAssessment`](webChat.md#op-updateassessment) | write |
|
|
2995
|
+
| GET | `/api/v1/webchat/blogs` | [`g8.api.webChat.listWebchatBlogs`](webChat.md#op-listwebchatblogs) | read |
|
|
2996
|
+
| POST | `/api/v1/webchat/blogs` | [`g8.api.webChat.createWebchatBlog`](webChat.md#op-createwebchatblog) | write |
|
|
2997
|
+
| POST | `/api/v1/webchat/blogs/fetch-metadata` | [`g8.api.webChat.fetchWebchatBlogMetadata`](webChat.md#op-fetchwebchatblogmetadata) | write |
|
|
2998
|
+
| DELETE | `/api/v1/webchat/blogs/{blog_id}` | [`g8.api.webChat.deleteWebchatBlog`](webChat.md#op-deletewebchatblog) | destructive |
|
|
2999
|
+
| PATCH | `/api/v1/webchat/blogs/{blog_id}` | [`g8.api.webChat.updateWebchatBlog`](webChat.md#op-updatewebchatblog) | write |
|
|
3000
|
+
| GET | `/api/v1/webchat/buttons` | [`g8.api.webChat.listWebchatButtons`](webChat.md#op-listwebchatbuttons) | read |
|
|
3001
|
+
| POST | `/api/v1/webchat/buttons` | [`g8.api.webChat.createWebchatButton`](webChat.md#op-createwebchatbutton) | write |
|
|
3002
|
+
| DELETE | `/api/v1/webchat/buttons/{button_id}` | [`g8.api.webChat.deleteWebchatButton`](webChat.md#op-deletewebchatbutton) | destructive |
|
|
3003
|
+
| PATCH | `/api/v1/webchat/buttons/{button_id}` | [`g8.api.webChat.updateWebchatButton`](webChat.md#op-updatewebchatbutton) | write |
|
|
3004
|
+
| GET | `/api/v1/webchat/chat-bots` | [`g8.api.webChat.listChatBots`](webChat.md#op-listchatbots) | read |
|
|
3005
|
+
| POST | `/api/v1/webchat/chat-bots` | [`g8.api.webChat.createChatBot`](webChat.md#op-createchatbot) | write |
|
|
3006
|
+
| DELETE | `/api/v1/webchat/chat-bots/{bot_id}` | [`g8.api.webChat.deleteChatBot`](webChat.md#op-deletechatbot) | destructive |
|
|
3007
|
+
| PATCH | `/api/v1/webchat/chat-bots/{bot_id}` | [`g8.api.webChat.updateChatBot`](webChat.md#op-updatechatbot) | write |
|
|
3008
|
+
| POST | `/api/v1/webchat/chat-bots/{bot_id}/promote-default` | [`g8.api.webChat.promoteChatBotToDefault`](webChat.md#op-promotechatbottodefault) | write |
|
|
3009
|
+
| GET | `/api/v1/webchat/handoff-pool` | [`g8.api.webChat.getWebchatHandoffPool`](webChat.md#op-getwebchathandoffpool) | read |
|
|
3010
|
+
| GET | `/api/v1/webchat/handoff-pool-status` | [`g8.api.webChat.getWebchatHandoffPoolStatus`](webChat.md#op-getwebchathandoffpoolstatus) | read |
|
|
3011
|
+
| POST | `/api/v1/webchat/handoff-pool/teams` | [`g8.api.webChat.addWebchatHandoffPoolTeams`](webChat.md#op-addwebchathandoffpoolteams) | write |
|
|
3012
|
+
| DELETE | `/api/v1/webchat/handoff-pool/teams/{team_id}` | [`g8.api.webChat.removeWebchatHandoffPoolTeam`](webChat.md#op-removewebchathandoffpoolteam) | destructive |
|
|
3013
|
+
| PATCH | `/api/v1/webchat/handoff-pool/teams/{team_id}/scope` | [`g8.api.webChat.updateWebchatHandoffPoolTeamScope`](webChat.md#op-updatewebchathandoffpoolteamscope) | write |
|
|
3014
|
+
| POST | `/api/v1/webchat/handoff-pool/users` | [`g8.api.webChat.addWebchatHandoffPoolUsers`](webChat.md#op-addwebchathandoffpoolusers) | write |
|
|
3015
|
+
| DELETE | `/api/v1/webchat/handoff-pool/users/{user_id}` | [`g8.api.webChat.removeWebchatHandoffPoolUser`](webChat.md#op-removewebchathandoffpooluser) | destructive |
|
|
3016
|
+
| PATCH | `/api/v1/webchat/handoff-pool/users/{user_id}/scope` | [`g8.api.webChat.updateWebchatHandoffPoolUserScope`](webChat.md#op-updatewebchathandoffpooluserscope) | write |
|
|
3017
|
+
| GET | `/api/v1/webchat/human-availability` | [`g8.api.webChat.getWebchatHumanAvailability`](webChat.md#op-getwebchathumanavailability) | read |
|
|
3018
|
+
| PUT | `/api/v1/webchat/human-availability` | [`g8.api.webChat.putWebchatHumanAvailability`](webChat.md#op-putwebchathumanavailability) | write |
|
|
3019
|
+
| POST | `/api/v1/webchat/images` | [`g8.api.webChat.uploadWebchatImage`](webChat.md#op-uploadwebchatimage) | write |
|
|
3020
|
+
| GET | `/api/v1/webchat/questions` | [`g8.api.webChat.listWebchatQuestions`](webChat.md#op-listwebchatquestions) | read |
|
|
3021
|
+
| POST | `/api/v1/webchat/questions` | [`g8.api.webChat.createWebchatQuestion`](webChat.md#op-createwebchatquestion) | write |
|
|
3022
|
+
| DELETE | `/api/v1/webchat/questions/{question_id}` | [`g8.api.webChat.deleteWebchatQuestion`](webChat.md#op-deletewebchatquestion) | destructive |
|
|
3023
|
+
| PATCH | `/api/v1/webchat/questions/{question_id}` | [`g8.api.webChat.updateWebchatQuestion`](webChat.md#op-updatewebchatquestion) | write |
|
|
3024
|
+
| DELETE | `/api/v1/webchat/settings` | [`g8.api.webChat.deleteWebchatSettings`](webChat.md#op-deletewebchatsettings) | destructive |
|
|
3025
|
+
| GET | `/api/v1/webchat/settings` | [`g8.api.webChat.getWebchatSettings`](webChat.md#op-getwebchatsettings) | read |
|
|
3026
|
+
| PATCH | `/api/v1/webchat/settings` | [`g8.api.webChat.updateWebchatSettings`](webChat.md#op-updatewebchatsettings) | write |
|
|
3027
|
+
| POST | `/api/v1/webchat/settings` | [`g8.api.webChat.createWebchatSettings`](webChat.md#op-createwebchatsettings) | write |
|
|
3028
|
+
| GET | `/api/v1/webchat/teams` | [`g8.api.webChat.listWebchatTeams`](webChat.md#op-listwebchatteams) | read |
|
|
3029
|
+
| GET | `/api/v1/webchat/teams/{team_id}/event-types` | [`g8.api.webChat.listWebchatTeamEventTypes`](webChat.md#op-listwebchatteameventtypes) | read |
|
|
3030
|
+
| GET | `/api/v1/webchat/visitors` | [`g8.api.webChat.listWebchatVisitors`](webChat.md#op-listwebchatvisitors) | read |
|
|
3031
|
+
| GET | `/api/v1/webchat/visitors/funnel` | [`g8.api.webChat.getWebchatVisitorFunnel`](webChat.md#op-getwebchatvisitorfunnel) | read |
|
|
3032
|
+
| GET | `/api/v1/webhooks` | [`g8.api.webhooks.listWebhooks`](webhooks.md#op-listwebhooks) | read |
|
|
3033
|
+
| POST | `/api/v1/webhooks` | [`g8.api.webhooks.createWebhook`](webhooks.md#op-createwebhook) | external |
|
|
3034
|
+
| GET | `/api/v1/webhooks/events` | [`g8.api.webhooks.listWebhookEvents`](webhooks.md#op-listwebhookevents) | read |
|
|
3035
|
+
| DELETE | `/api/v1/webhooks/{webhook_id}` | [`g8.api.webhooks.deleteWebhook`](webhooks.md#op-deletewebhook) | destructive |
|
|
3036
|
+
| GET | `/api/v1/webhooks/{webhook_id}` | [`g8.api.webhooks.getWebhook`](webhooks.md#op-getwebhook) | read |
|
|
3037
|
+
| PATCH | `/api/v1/webhooks/{webhook_id}` | [`g8.api.webhooks.updateWebhook`](webhooks.md#op-updatewebhook) | external |
|
|
3038
|
+
| GET | `/api/v1/webhooks/{webhook_id}/deliveries` | [`g8.api.webhooks.listWebhookDeliveries`](webhooks.md#op-listwebhookdeliveries) | read |
|
|
3039
|
+
| POST | `/api/v1/webhooks/{webhook_id}/rotate-secret` | [`g8.api.webhooks.rotateWebhookSecret`](webhooks.md#op-rotatewebhooksecret) | external |
|
|
3040
|
+
| POST | `/api/v1/website-editor/connect` | [`g8.api.websiteEditor.connectWebsiteHosting`](websiteEditor.md#op-connectwebsitehosting) | write |
|
|
3041
|
+
| GET | `/api/v1/website-editor/connection` | [`g8.api.websiteEditor.getWebsiteHostingConnection`](websiteEditor.md#op-getwebsitehostingconnection) | read |
|
|
3042
|
+
| DELETE | `/api/v1/website-editor/disconnect` | [`g8.api.websiteEditor.disconnectWebsiteHosting`](websiteEditor.md#op-disconnectwebsitehosting) | destructive |
|
|
3043
|
+
| POST | `/api/v1/website-editor/pages/{page_id}/clone` | [`g8.api.websiteEditor.cloneWebsitePage`](websiteEditor.md#op-clonewebsitepage) | write |
|
|
3044
|
+
| GET | `/api/v1/website-editor/pages/{page_id}/conversation` | [`g8.api.websiteEditor.getWebsitePageConversation`](websiteEditor.md#op-getwebsitepageconversation) | read |
|
|
3045
|
+
| POST | `/api/v1/website-editor/pages/{page_id}/ops` | [`g8.api.websiteEditor.applyWebsitePageOperations`](websiteEditor.md#op-applywebsitepageoperations) | write |
|
|
3046
|
+
| POST | `/api/v1/website-editor/pages/{page_id}/restore-version` | [`g8.api.websiteEditor.restoreWebsitePageVersion`](websiteEditor.md#op-restorewebsitepageversion) | write |
|
|
3047
|
+
| POST | `/api/v1/website-editor/pages/{page_id}/update-text` | [`g8.api.websiteEditor.updateWebsitePageText`](websiteEditor.md#op-updatewebsitepagetext) | write |
|
|
3048
|
+
| GET | `/api/v1/website-editor/pages/{page_id}/versions` | [`g8.api.websiteEditor.listWebsitePageVersions`](websiteEditor.md#op-listwebsitepageversions) | read |
|
|
3049
|
+
| GET | `/api/v1/website-editor/projects` | [`g8.api.websiteEditor.listWebsiteHostingProjects`](websiteEditor.md#op-listwebsitehostingprojects) | read |
|
|
3050
|
+
| POST | `/api/v1/website-editor/publish` | [`g8.api.websiteEditor.publishWebsitePages`](websiteEditor.md#op-publishwebsitepages) | external |
|
|
3051
|
+
| POST | `/api/v1/website-editor/sync` | [`g8.api.websiteEditor.syncWebsitePages`](websiteEditor.md#op-syncwebsitepages) | external |
|
|
3052
|
+
| GET | `/api/v1/work/activity` | [`g8.api.work.listWorkActivity`](work.md#op-listworkactivity) | read |
|
|
3053
|
+
| GET | `/api/v1/work/agents` | [`g8.api.work.listWorkAgents`](work.md#op-listworkagents) | read |
|
|
3054
|
+
| POST | `/api/v1/work/agents` | [`g8.api.work.createWorkAgent`](work.md#op-createworkagent) | write |
|
|
3055
|
+
| GET | `/api/v1/work/agents/execution-identities` | [`g8.api.work.listWorkAgentExecutionIdentities`](work.md#op-listworkagentexecutionidentities) | read |
|
|
3056
|
+
| GET | `/api/v1/work/agents/policy` | [`g8.api.work.getWorkAgentPolicy`](work.md#op-getworkagentpolicy) | read |
|
|
3057
|
+
| DELETE | `/api/v1/work/agents/{agent_id}` | [`g8.api.work.archiveWorkAgent`](work.md#op-archiveworkagent) | destructive |
|
|
3058
|
+
| GET | `/api/v1/work/agents/{agent_id}` | [`g8.api.work.getWorkAgent`](work.md#op-getworkagent) | read |
|
|
3059
|
+
| PATCH | `/api/v1/work/agents/{agent_id}` | [`g8.api.work.updateWorkAgent`](work.md#op-updateworkagent) | write |
|
|
3060
|
+
| GET | `/api/v1/work/attachments/{attachment_id}` | [`g8.api.work.getWorkAttachmentLink`](work.md#op-getworkattachmentlink) | read |
|
|
3061
|
+
| GET | `/api/v1/work/channels` | [`g8.api.work.listWorkChannels`](work.md#op-listworkchannels) | read |
|
|
3062
|
+
| POST | `/api/v1/work/channels` | [`g8.api.work.createWorkChannel`](work.md#op-createworkchannel) | write |
|
|
3063
|
+
| GET | `/api/v1/work/channels/available` | [`g8.api.work.listAvailableWorkChannels`](work.md#op-listavailableworkchannels) | read |
|
|
3064
|
+
| DELETE | `/api/v1/work/channels/{channel_id}` | [`g8.api.work.deleteWorkChannel`](work.md#op-deleteworkchannel) | destructive |
|
|
3065
|
+
| PATCH | `/api/v1/work/channels/{channel_id}` | [`g8.api.work.updateWorkChannel`](work.md#op-updateworkchannel) | write |
|
|
3066
|
+
| GET | `/api/v1/work/channels/{channel_id}/canvas` | [`g8.api.work.getWorkChannelCanvas`](work.md#op-getworkchannelcanvas) | read |
|
|
3067
|
+
| POST | `/api/v1/work/channels/{channel_id}/canvas` | [`g8.api.work.saveWorkChannelCanvas`](work.md#op-saveworkchannelcanvas) | write |
|
|
3068
|
+
| PUT | `/api/v1/work/channels/{channel_id}/purpose` | [`g8.api.work.setWorkChannelPurpose`](work.md#op-setworkchannelpurpose) | write |
|
|
3069
|
+
| GET | `/api/v1/work/conversations/{conversation_id}/events` | [`g8.api.work.listWorkConversationEvents`](work.md#op-listworkconversationevents) | read |
|
|
3070
|
+
| GET | `/api/v1/work/conversations/{conversation_id}/files` | [`g8.api.work.listWorkConversationFiles`](work.md#op-listworkconversationfiles) | read |
|
|
3071
|
+
| GET | `/api/v1/work/conversations/{conversation_id}/messages` | [`g8.api.work.listWorkConversationMessages`](work.md#op-listworkconversationmessages) | read |
|
|
3072
|
+
| POST | `/api/v1/work/custom-emoji` | [`g8.api.work.addWorkCustomEmoji`](work.md#op-addworkcustomemoji) | write |
|
|
3073
|
+
| GET | `/api/v1/work/inbox-dispositions` | [`g8.api.work.getWorkInboxDispositions`](work.md#op-getworkinboxdispositions) | read |
|
|
3074
|
+
| POST | `/api/v1/work/inbox-dispositions` | [`g8.api.work.setWorkInboxDisposition`](work.md#op-setworkinboxdisposition) | write |
|
|
3075
|
+
| GET | `/api/v1/work/memory` | [`g8.api.work.getWorkMemory`](work.md#op-getworkmemory) | read |
|
|
3076
|
+
| PUT | `/api/v1/work/memory` | [`g8.api.work.editWorkMemory`](work.md#op-editworkmemory) | write |
|
|
3077
|
+
| POST | `/api/v1/work/memory/move` | [`g8.api.work.moveWorkMemory`](work.md#op-moveworkmemory) | write |
|
|
3078
|
+
| POST | `/api/v1/work/messages` | [`g8.api.work.createWorkMessage`](work.md#op-createworkmessage) | write |
|
|
3079
|
+
| DELETE | `/api/v1/work/messages/{message_id}` | [`g8.api.work.deleteWorkMessage`](work.md#op-deleteworkmessage) | destructive |
|
|
3080
|
+
| GET | `/api/v1/work/messages/{message_id}` | [`g8.api.work.getWorkMessage`](work.md#op-getworkmessage) | read |
|
|
3081
|
+
| PATCH | `/api/v1/work/messages/{message_id}` | [`g8.api.work.editWorkMessage`](work.md#op-editworkmessage) | write |
|
|
3082
|
+
| POST | `/api/v1/work/messages/{message_id}/forward` | [`g8.api.work.forwardWorkMessage`](work.md#op-forwardworkmessage) | write |
|
|
3083
|
+
| PUT | `/api/v1/work/messages/{message_id}/reaction` | [`g8.api.work.reactToWorkMessage`](work.md#op-reacttoworkmessage) | write |
|
|
3084
|
+
| GET | `/api/v1/work/oversight` | [`g8.api.work.getWorkOversight`](work.md#op-getworkoversight) | read |
|
|
3085
|
+
| GET | `/api/v1/work/preferences/daily-brief` | [`g8.api.work.getWorkDailyBrief`](work.md#op-getworkdailybrief) | read |
|
|
3086
|
+
| POST | `/api/v1/work/preferences/daily-brief` | [`g8.api.work.setWorkDailyBrief`](work.md#op-setworkdailybrief) | write |
|
|
3087
|
+
| POST | `/api/v1/work/projects` | [`g8.api.work.createWorkProject`](work.md#op-createworkproject) | write |
|
|
3088
|
+
| DELETE | `/api/v1/work/projects/{project_id}` | [`g8.api.work.deleteWorkProject`](work.md#op-deleteworkproject) | destructive |
|
|
3089
|
+
| PATCH | `/api/v1/work/projects/{project_id}` | [`g8.api.work.updateWorkProject`](work.md#op-updateworkproject) | write |
|
|
3090
|
+
| POST | `/api/v1/work/pulse` | [`g8.api.work.addWorkPulseNote`](work.md#op-addworkpulsenote) | write |
|
|
3091
|
+
| POST | `/api/v1/work/pulse/{note_id}/reaction` | [`g8.api.work.setWorkPulseReaction`](work.md#op-setworkpulsereaction) | write |
|
|
3092
|
+
| GET | `/api/v1/work/read-markers` | [`g8.api.work.getWorkReadMarkers`](work.md#op-getworkreadmarkers) | read |
|
|
3093
|
+
| POST | `/api/v1/work/read-markers` | [`g8.api.work.setWorkReadMarkers`](work.md#op-setworkreadmarkers) | write |
|
|
3094
|
+
| GET | `/api/v1/work/room` | [`g8.api.work.getWorkRoom`](work.md#op-getworkroom) | read |
|
|
3095
|
+
| GET | `/api/v1/work/routines` | [`g8.api.work.listWorkRoutines`](work.md#op-listworkroutines) | read |
|
|
3096
|
+
| POST | `/api/v1/work/routines` | [`g8.api.work.createWorkRoutine`](work.md#op-createworkroutine) | write |
|
|
3097
|
+
| DELETE | `/api/v1/work/routines/{routine_id}` | [`g8.api.work.deleteWorkRoutine`](work.md#op-deleteworkroutine) | destructive |
|
|
3098
|
+
| PATCH | `/api/v1/work/routines/{routine_id}` | [`g8.api.work.updateWorkRoutine`](work.md#op-updateworkroutine) | write |
|
|
3099
|
+
| POST | `/api/v1/work/routines/{routine_id}/run` | [`g8.api.work.runWorkRoutineNow`](work.md#op-runworkroutinenow) | write |
|
|
3100
|
+
| GET | `/api/v1/work/routines/{routine_id}/runs` | [`g8.api.work.listWorkRoutineRuns`](work.md#op-listworkroutineruns) | billable |
|
|
3101
|
+
| GET | `/api/v1/work/search` | [`g8.api.work.searchWork`](work.md#op-searchwork) | read |
|
|
3102
|
+
| POST | `/api/v1/work/sidebar-preferences` | [`g8.api.work.setWorkSidebarPreferences`](work.md#op-setworksidebarpreferences) | write |
|
|
3103
|
+
| POST | `/api/v1/work/signals/promote` | [`g8.api.work.promoteWorkSignal`](work.md#op-promoteworksignal) | billable |
|
|
3104
|
+
| POST | `/api/v1/work/signals/state` | [`g8.api.work.setWorkSignalState`](work.md#op-setworksignalstate) | write |
|
|
3105
|
+
| GET | `/api/v1/work/team-hq/history` | [`g8.api.work.getWorkTeamHistory`](work.md#op-getworkteamhistory) | read |
|
|
3106
|
+
| GET | `/api/v1/work/team-hq/leaderboard` | [`g8.api.work.getWorkTeamLeaderboard`](work.md#op-getworkteamleaderboard) | read |
|
|
3107
|
+
| GET | `/api/v1/work/team-hq/receipts` | [`g8.api.work.listWorkTeamReceipts`](work.md#op-listworkteamreceipts) | read |
|
|
3108
|
+
| GET | `/api/v1/work/team-hq/recent-activity` | [`g8.api.work.listWorkRecentActivity`](work.md#op-listworkrecentactivity) | read |
|
|
3109
|
+
| GET | `/api/v1/work/work-items` | [`g8.api.work.listWorkItems`](work.md#op-listworkitems) | read |
|
|
3110
|
+
| GET | `/api/v1/work/work-items/history` | [`g8.api.work.listWorkItemHistory`](work.md#op-listworkitemhistory) | read |
|
|
3111
|
+
| GET | `/api/v1/workbench-bindings` | [`g8.api.workbench.listWorkbenchBindings`](workbench.md#op-listworkbenchbindings) | read |
|
|
3112
|
+
| POST | `/api/v1/workbench-bindings` | [`g8.api.workbench.createWorkbenchBindings`](workbench.md#op-createworkbenchbindings) | write |
|
|
3113
|
+
| DELETE | `/api/v1/workbench-bindings/{binding_id}` | [`g8.api.workbench.deleteWorkbenchBinding`](workbench.md#op-deleteworkbenchbinding) | destructive |
|
|
3114
|
+
| GET | `/api/v1/workbench/ai-presets` | [`g8.api.workbench.listWorkbenchAiPresets`](workbench.md#op-listworkbenchaipresets) | read |
|
|
3115
|
+
| GET | `/api/v1/workbench/scraper/credit-estimate` | [`g8.api.workbench.estimateWorkbenchScraperCredits`](workbench.md#op-estimateworkbenchscrapercredits) | read |
|
|
3116
|
+
| GET | `/api/v1/workbench/scraper/presets` | [`g8.api.workbench.listWorkbenchScraperPresets`](workbench.md#op-listworkbenchscraperpresets) | read |
|
|
3117
|
+
| GET | `/api/v1/workbench/scraper/providers/{provider}/check-token` | [`g8.api.workbench.checkWorkbenchScraperToken`](workbench.md#op-checkworkbenchscrapertoken) | read |
|
|
3118
|
+
| DELETE | `/api/v1/workbench/scraper/providers/{provider}/connection` | [`g8.api.workbench.deleteScraperProviderConnection`](workbench.md#op-deletescraperproviderconnection) | destructive |
|
|
3119
|
+
| GET | `/api/v1/workbench/scraper/providers/{provider}/connection` | [`g8.api.workbench.getScraperProviderConnection`](workbench.md#op-getscraperproviderconnection) | read |
|
|
3120
|
+
| PUT | `/api/v1/workbench/scraper/providers/{provider}/connection` | [`g8.api.workbench.saveScraperProviderConnection`](workbench.md#op-savescraperproviderconnection) | write |
|
|
3121
|
+
| POST | `/api/v1/workbench/scraper/providers/{provider}/connection/test` | [`g8.api.workbench.testScraperProviderConnection`](workbench.md#op-testscraperproviderconnection) | external |
|
|
3122
|
+
| GET | `/api/v1/workbench/scraper/providers/{provider}/credit-estimate` | [`g8.api.workbench.estimateWorkbenchProviderScraperCredits`](workbench.md#op-estimateworkbenchproviderscrapercredits) | read |
|
|
3123
|
+
| GET | `/api/v1/workbench/source-credentials` | [`g8.api.workbench.listWorkbenchSourceCredentials`](workbench.md#op-listworkbenchsourcecredentials) | read |
|
|
3124
|
+
| GET | `/api/v1/workbench/tables` | [`g8.api.workbench.listWorkbenchTables`](workbench.md#op-listworkbenchtables) | read |
|
|
3125
|
+
| POST | `/api/v1/workbench/tables` | [`g8.api.workbench.createWorkbenchTable`](workbench.md#op-createworkbenchtable) | write |
|
|
3126
|
+
| DELETE | `/api/v1/workbench/tables/{table_id}` | [`g8.api.workbench.deleteWorkbenchTable`](workbench.md#op-deleteworkbenchtable) | destructive |
|
|
3127
|
+
| GET | `/api/v1/workbench/tables/{table_id}` | [`g8.api.workbench.getWorkbenchTable`](workbench.md#op-getworkbenchtable) | read |
|
|
3128
|
+
| PUT | `/api/v1/workbench/tables/{table_id}` | [`g8.api.workbench.updateWorkbenchTable`](workbench.md#op-updateworkbenchtable) | write |
|
|
3129
|
+
| GET | `/api/v1/workbench/tables/{table_id}/ai-presets` | [`g8.api.workbench.listWorkbenchTableAiPresets`](workbench.md#op-listworkbenchtableaipresets) | read |
|
|
3130
|
+
| POST | `/api/v1/workbench/tables/{table_id}/ai/configure` | [`g8.api.workbench.configureWorkbenchAi`](workbench.md#op-configureworkbenchai) | write |
|
|
3131
|
+
| POST | `/api/v1/workbench/tables/{table_id}/ai/generate-prompt` | [`g8.api.workbench.generateWorkbenchPrompt`](workbench.md#op-generateworkbenchprompt) | billable |
|
|
3132
|
+
| POST | `/api/v1/workbench/tables/{table_id}/ai/groups/config` | [`g8.api.workbench.createWorkbenchAiGroup`](workbench.md#op-createworkbenchaigroup) | write |
|
|
3133
|
+
| DELETE | `/api/v1/workbench/tables/{table_id}/ai/groups/{group_id}` | [`g8.api.workbench.deleteWorkbenchAiGroup`](workbench.md#op-deleteworkbenchaigroup) | destructive |
|
|
3134
|
+
| GET | `/api/v1/workbench/tables/{table_id}/ai/groups/{group_id}` | [`g8.api.workbench.getWorkbenchAiGroup`](workbench.md#op-getworkbenchaigroup) | read |
|
|
3135
|
+
| PUT | `/api/v1/workbench/tables/{table_id}/ai/groups/{group_id}` | [`g8.api.workbench.updateWorkbenchAiGroup`](workbench.md#op-updateworkbenchaigroup) | write |
|
|
3136
|
+
| POST | `/api/v1/workbench/tables/{table_id}/ai/groups/{group_id}/find-people/export` | [`g8.api.workbench.exportWorkbenchAiFindPeople`](workbench.md#op-exportworkbenchaifindpeople) | write |
|
|
3137
|
+
| GET | `/api/v1/workbench/tables/{table_id}/ai/groups/{group_id}/find-people/review` | [`g8.api.workbench.reviewWorkbenchFindPeopleCandidates`](workbench.md#op-reviewworkbenchfindpeoplecandidates) | read |
|
|
3138
|
+
| GET | `/api/v1/workbench/tables/{table_id}/ai/groups/{group_id}/find-people/rows/{source_row_id}` | [`g8.api.workbench.getWorkbenchAiFindPeopleRow`](workbench.md#op-getworkbenchaifindpeoplerow) | read |
|
|
3139
|
+
| POST | `/api/v1/workbench/tables/{table_id}/ai/groups/{group_id}/find-people/skip` | [`g8.api.workbench.skipWorkbenchFindPeopleCandidates`](workbench.md#op-skipworkbenchfindpeoplecandidates) | write |
|
|
3140
|
+
| POST | `/api/v1/workbench/tables/{table_id}/ai/groups/{group_id}/run` | [`g8.api.workbench.runWorkbenchAiGroup`](workbench.md#op-runworkbenchaigroup) | billable |
|
|
3141
|
+
| POST | `/api/v1/workbench/tables/{table_id}/ai/migrate-legacy` | [`g8.api.workbench.migrateWorkbenchLegacyAiConfig`](workbench.md#op-migrateworkbenchlegacyaiconfig) | write |
|
|
3142
|
+
| POST | `/api/v1/workbench/tables/{table_id}/ai/preview` | [`g8.api.workbench.previewWorkbenchAi`](workbench.md#op-previewworkbenchai) | billable |
|
|
3143
|
+
| POST | `/api/v1/workbench/tables/{table_id}/ai/run` | [`g8.api.workbench.runWorkbenchDefaultAi`](workbench.md#op-runworkbenchdefaultai) | billable |
|
|
3144
|
+
| POST | `/api/v1/workbench/tables/{table_id}/ai/run-all` | [`g8.api.workbench.runWorkbenchAi`](workbench.md#op-runworkbenchai) | billable |
|
|
3145
|
+
| POST | `/api/v1/workbench/tables/{table_id}/ai/validate-credits` | [`g8.api.workbench.quoteWorkbenchAiRun`](workbench.md#op-quoteworkbenchairun) | read |
|
|
3146
|
+
| GET | `/api/v1/workbench/tables/{table_id}/analytics` | [`g8.api.workbench.getWorkbenchAnalytics`](workbench.md#op-getworkbenchanalytics) | read |
|
|
3147
|
+
| PUT | `/api/v1/workbench/tables/{table_id}/auto-enrich` | [`g8.api.workbench.setWorkbenchAutoEnrich`](workbench.md#op-setworkbenchautoenrich) | billable |
|
|
3148
|
+
| GET | `/api/v1/workbench/tables/{table_id}/columns` | [`g8.api.workbench.listWorkbenchColumns`](workbench.md#op-listworkbenchcolumns) | read |
|
|
3149
|
+
| POST | `/api/v1/workbench/tables/{table_id}/columns` | [`g8.api.workbench.addWorkbenchColumn`](workbench.md#op-addworkbenchcolumn) | write |
|
|
3150
|
+
| POST | `/api/v1/workbench/tables/{table_id}/columns/bulk-extract` | [`g8.api.workbench.bulkExtractWorkbenchColumns`](workbench.md#op-bulkextractworkbenchcolumns) | write |
|
|
3151
|
+
| POST | `/api/v1/workbench/tables/{table_id}/columns/extract` | [`g8.api.workbench.extractWorkbenchColumn`](workbench.md#op-extractworkbenchcolumn) | write |
|
|
3152
|
+
| GET | `/api/v1/workbench/tables/{table_id}/columns/{col_id}/ai-config` | [`g8.api.workbench.getWorkbenchColumnAiConfig`](workbench.md#op-getworkbenchcolumnaiconfig) | read |
|
|
3153
|
+
| PUT | `/api/v1/workbench/tables/{table_id}/columns/{col_id}/ai-config` | [`g8.api.workbench.saveWorkbenchColumnAiConfig`](workbench.md#op-saveworkbenchcolumnaiconfig) | write |
|
|
3154
|
+
| POST | `/api/v1/workbench/tables/{table_id}/columns/{col_id}/ai/run` | [`g8.api.workbench.runWorkbenchColumnAi`](workbench.md#op-runworkbenchcolumnai) | billable |
|
|
3155
|
+
| POST | `/api/v1/workbench/tables/{table_id}/columns/{col_id}/compute` | [`g8.api.workbench.computeWorkbenchFormula`](workbench.md#op-computeworkbenchformula) | write |
|
|
3156
|
+
| GET | `/api/v1/workbench/tables/{table_id}/columns/{col_id}/sources` | [`g8.api.workbench.listWorkbenchColumnSources`](workbench.md#op-listworkbenchcolumnsources) | read |
|
|
3157
|
+
| POST | `/api/v1/workbench/tables/{table_id}/columns/{col_id}/sources` | [`g8.api.workbench.configureWorkbenchColumnSource`](workbench.md#op-configureworkbenchcolumnsource) | write |
|
|
3158
|
+
| DELETE | `/api/v1/workbench/tables/{table_id}/columns/{col_id}/sources/{source_type}` | [`g8.api.workbench.revokeWorkbenchColumnSource`](workbench.md#op-revokeworkbenchcolumnsource) | destructive |
|
|
3159
|
+
| DELETE | `/api/v1/workbench/tables/{table_id}/columns/{column_id}` | [`g8.api.workbench.deleteWorkbenchColumn`](workbench.md#op-deleteworkbenchcolumn) | destructive |
|
|
3160
|
+
| PUT | `/api/v1/workbench/tables/{table_id}/columns/{column_id}/mapping` | [`g8.api.workbench.mapWorkbenchColumn`](workbench.md#op-mapworkbenchcolumn) | write |
|
|
3161
|
+
| GET | `/api/v1/workbench/tables/{table_id}/connections` | [`g8.api.workbench.listWorkbenchConnections`](workbench.md#op-listworkbenchconnections) | read |
|
|
3162
|
+
| POST | `/api/v1/workbench/tables/{table_id}/connections` | [`g8.api.workbench.createWorkbenchConnection`](workbench.md#op-createworkbenchconnection) | write |
|
|
3163
|
+
| DELETE | `/api/v1/workbench/tables/{table_id}/connections/{connection_id}` | [`g8.api.workbench.deleteWorkbenchConnection`](workbench.md#op-deleteworkbenchconnection) | destructive |
|
|
3164
|
+
| POST | `/api/v1/workbench/tables/{table_id}/connections/{connection_id}/sync` | [`g8.api.workbench.syncWorkbenchConnection`](workbench.md#op-syncworkbenchconnection) | write |
|
|
3165
|
+
| POST | `/api/v1/workbench/tables/{table_id}/discover-fields` | [`g8.api.workbench.discoverWorkbenchFields`](workbench.md#op-discoverworkbenchfields) | write |
|
|
3166
|
+
| GET | `/api/v1/workbench/tables/{table_id}/enrichment-configs` | [`g8.api.workbench.listWorkbenchEnrichmentConfigs`](workbench.md#op-listworkbenchenrichmentconfigs) | read |
|
|
3167
|
+
| POST | `/api/v1/workbench/tables/{table_id}/expand-array` | [`g8.api.workbench.expandWorkbenchArray`](workbench.md#op-expandworkbencharray) | write |
|
|
3168
|
+
| POST | `/api/v1/workbench/tables/{table_id}/export` | [`g8.api.workbench.exportWorkbenchTable`](workbench.md#op-exportworkbenchtable) | write |
|
|
3169
|
+
| GET | `/api/v1/workbench/tables/{table_id}/find-people/configs` | [`g8.api.workbench.listWorkbenchFindPeopleConfigs`](workbench.md#op-listworkbenchfindpeopleconfigs) | read |
|
|
3170
|
+
| POST | `/api/v1/workbench/tables/{table_id}/find-people/configure` | [`g8.api.workbench.configureWorkbenchFindPeople`](workbench.md#op-configureworkbenchfindpeople) | billable |
|
|
3171
|
+
| DELETE | `/api/v1/workbench/tables/{table_id}/find-people/{config_id}` | [`g8.api.workbench.deleteWorkbenchFindPeopleConfig`](workbench.md#op-deleteworkbenchfindpeopleconfig) | destructive |
|
|
3172
|
+
| GET | `/api/v1/workbench/tables/{table_id}/find-people/{config_id}/contacts` | [`g8.api.workbench.listWorkbenchFindPeopleContacts`](workbench.md#op-listworkbenchfindpeoplecontacts) | read |
|
|
3173
|
+
| POST | `/api/v1/workbench/tables/{table_id}/find-people/{config_id}/run` | [`g8.api.workbench.runWorkbenchFindPeople`](workbench.md#op-runworkbenchfindpeople) | billable |
|
|
3174
|
+
| POST | `/api/v1/workbench/tables/{table_id}/formula-columns` | [`g8.api.workbench.createWorkbenchFormulaColumns`](workbench.md#op-createworkbenchformulacolumns) | write |
|
|
3175
|
+
| GET | `/api/v1/workbench/tables/{table_id}/formula-columns/generate-quote` | [`g8.api.workbench.quoteWorkbenchFormulaGeneration`](workbench.md#op-quoteworkbenchformulageneration) | read |
|
|
3176
|
+
| GET | `/api/v1/workbench/tables/{table_id}/history` | [`g8.api.workbench.getWorkbenchHistory`](workbench.md#op-getworkbenchhistory) | read |
|
|
3177
|
+
| POST | `/api/v1/workbench/tables/{table_id}/import/crm` | [`g8.api.workbench.importWorkbenchFromCrm`](workbench.md#op-importworkbenchfromcrm) | external |
|
|
3178
|
+
| POST | `/api/v1/workbench/tables/{table_id}/import/datafile` | [`g8.api.workbench.importWorkbenchDatafile`](workbench.md#op-importworkbenchdatafile) | write |
|
|
3179
|
+
| POST | `/api/v1/workbench/tables/{table_id}/import/paste` | [`g8.api.workbench.pasteImportWorkbenchRows`](workbench.md#op-pasteimportworkbenchrows) | write |
|
|
3180
|
+
| POST | `/api/v1/workbench/tables/{table_id}/import/search` | [`g8.api.workbench.importWorkbenchFromSearch`](workbench.md#op-importworkbenchfromsearch) | billable |
|
|
3181
|
+
| POST | `/api/v1/workbench/tables/{table_id}/import/search/preview` | [`g8.api.workbench.previewWorkbenchSearchImport`](workbench.md#op-previewworkbenchsearchimport) | read |
|
|
3182
|
+
| POST | `/api/v1/workbench/tables/{table_id}/import/search/research/preview` | [`g8.api.workbench.previewWorkbenchResearchImport`](workbench.md#op-previewworkbenchresearchimport) | billable |
|
|
3183
|
+
| GET | `/api/v1/workbench/tables/{table_id}/locked-row-count` | [`g8.api.workbench.getWorkbenchLockedRowCount`](workbench.md#op-getworkbenchlockedrowcount) | read |
|
|
3184
|
+
| GET | `/api/v1/workbench/tables/{table_id}/pipelines` | [`g8.api.workbench.listWorkbenchPipelines`](workbench.md#op-listworkbenchpipelines) | read |
|
|
3185
|
+
| POST | `/api/v1/workbench/tables/{table_id}/pipelines` | [`g8.api.workbench.createWorkbenchPipeline`](workbench.md#op-createworkbenchpipeline) | billable |
|
|
3186
|
+
| DELETE | `/api/v1/workbench/tables/{table_id}/pipelines/{pipeline_id}` | [`g8.api.workbench.deleteWorkbenchPipeline`](workbench.md#op-deleteworkbenchpipeline) | destructive |
|
|
3187
|
+
| GET | `/api/v1/workbench/tables/{table_id}/pipelines/{pipeline_id}` | [`g8.api.workbench.getWorkbenchPipeline`](workbench.md#op-getworkbenchpipeline) | read |
|
|
3188
|
+
| PUT | `/api/v1/workbench/tables/{table_id}/pipelines/{pipeline_id}` | [`g8.api.workbench.updateWorkbenchPipeline`](workbench.md#op-updateworkbenchpipeline) | billable |
|
|
3189
|
+
| POST | `/api/v1/workbench/tables/{table_id}/regenerate-key` | [`g8.api.workbench.regenerateWorkbenchKey`](workbench.md#op-regenerateworkbenchkey) | write |
|
|
3190
|
+
| GET | `/api/v1/workbench/tables/{table_id}/rows` | [`g8.api.workbench.listWorkbenchRows`](workbench.md#op-listworkbenchrows) | read |
|
|
3191
|
+
| POST | `/api/v1/workbench/tables/{table_id}/rows` | [`g8.api.workbench.addWorkbenchRow`](workbench.md#op-addworkbenchrow) | write |
|
|
3192
|
+
| POST | `/api/v1/workbench/tables/{table_id}/rows/bulk-delete` | [`g8.api.workbench.bulkDeleteWorkbenchRows`](workbench.md#op-bulkdeleteworkbenchrows) | destructive |
|
|
3193
|
+
| POST | `/api/v1/workbench/tables/{table_id}/rows/query` | [`g8.api.workbench.queryWorkbenchRows`](workbench.md#op-queryworkbenchrows) | read |
|
|
3194
|
+
| GET | `/api/v1/workbench/tables/{table_id}/rows/{row_id}` | [`g8.api.workbench.getWorkbenchRow`](workbench.md#op-getworkbenchrow) | read |
|
|
3195
|
+
| PATCH | `/api/v1/workbench/tables/{table_id}/rows/{row_id}` | [`g8.api.workbench.updateWorkbenchRow`](workbench.md#op-updateworkbenchrow) | write |
|
|
3196
|
+
| DELETE | `/api/v1/workbench/tables/{table_id}/schedule` | [`g8.api.workbench.deleteWorkbenchSchedule`](workbench.md#op-deleteworkbenchschedule) | destructive |
|
|
3197
|
+
| GET | `/api/v1/workbench/tables/{table_id}/schedule` | [`g8.api.workbench.getWorkbenchSchedule`](workbench.md#op-getworkbenchschedule) | read |
|
|
3198
|
+
| PUT | `/api/v1/workbench/tables/{table_id}/schedule` | [`g8.api.workbench.setWorkbenchSchedule`](workbench.md#op-setworkbenchschedule) | billable |
|
|
3199
|
+
| POST | `/api/v1/workbench/tables/{table_id}/scraper/providers/{provider}/runs` | [`g8.api.workbench.runWorkbenchProviderScraper`](workbench.md#op-runworkbenchproviderscraper) | billable |
|
|
3200
|
+
| GET | `/api/v1/workbench/tables/{table_id}/scraper/runs` | [`g8.api.workbench.listWorkbenchScraperRuns`](workbench.md#op-listworkbenchscraperruns) | read |
|
|
3201
|
+
| POST | `/api/v1/workbench/tables/{table_id}/scraper/runs` | [`g8.api.workbench.runWorkbenchScraper`](workbench.md#op-runworkbenchscraper) | billable |
|
|
3202
|
+
| GET | `/api/v1/workbench/tables/{table_id}/scraper/runs/{run_id}` | [`g8.api.workbench.getWorkbenchScraperRun`](workbench.md#op-getworkbenchscraperrun) | read |
|
|
3203
|
+
| POST | `/api/v1/workbench/tables/{table_id}/send-to-sequence` | [`g8.api.workbench.sendWorkbenchRowsToSequence`](workbench.md#op-sendworkbenchrowstosequence) | external |
|
|
3204
|
+
| POST | `/api/v1/workbench/tables/{table_id}/suggest-mappings` | [`g8.api.workbench.suggestWorkbenchMappings`](workbench.md#op-suggestworkbenchmappings) | billable |
|
|
3205
|
+
| GET | `/api/v1/workbench/tables/{table_id}/suggest-mappings/{job_id}` | [`g8.api.workbench.getWorkbenchMappingSuggestion`](workbench.md#op-getworkbenchmappingsuggestion) | read |
|
|
3206
|
+
| GET | `/api/v1/workbench/tables/{table_id}/triggers` | [`g8.api.workbench.listWorkbenchTriggers`](workbench.md#op-listworkbenchtriggers) | read |
|
|
3207
|
+
| POST | `/api/v1/workbench/tables/{table_id}/triggers` | [`g8.api.workbench.createWorkbenchTrigger`](workbench.md#op-createworkbenchtrigger) | billable |
|
|
3208
|
+
| DELETE | `/api/v1/workbench/tables/{table_id}/triggers/{trigger_id}` | [`g8.api.workbench.deleteWorkbenchTrigger`](workbench.md#op-deleteworkbenchtrigger) | destructive |
|
|
3209
|
+
| PUT | `/api/v1/workbench/tables/{table_id}/triggers/{trigger_id}` | [`g8.api.workbench.updateWorkbenchTrigger`](workbench.md#op-updateworkbenchtrigger) | billable |
|
|
3210
|
+
| POST | `/api/v1/workbench/tables/{table_id}/unlock-quote` | [`g8.api.workbench.quoteWorkbenchUnlock`](workbench.md#op-quoteworkbenchunlock) | read |
|
|
3211
|
+
| POST | `/api/v1/workbench/tables/{table_id}/unlock-rows` | [`g8.api.workbench.unlockWorkbenchRows`](workbench.md#op-unlockworkbenchrows) | billable |
|
|
3212
|
+
| POST | `/api/v1/workbench/tables/{table_id}/waterfall/configs` | [`g8.api.workbench.saveWorkbenchWaterfall`](workbench.md#op-saveworkbenchwaterfall) | write |
|
|
3213
|
+
| GET | `/api/v1/workbench/tables/{table_id}/waterfall/configs/{column_id}` | [`g8.api.workbench.getWorkbenchWaterfall`](workbench.md#op-getworkbenchwaterfall) | read |
|
|
3214
|
+
| PUT | `/api/v1/workbench/tables/{table_id}/waterfall/configs/{column_id}` | [`g8.api.workbench.updateWorkbenchWaterfall`](workbench.md#op-updateworkbenchwaterfall) | write |
|
|
3215
|
+
| POST | `/api/v1/workbench/tables/{table_id}/waterfall/configs/{column_id}/run` | [`g8.api.workbench.runWorkbenchWaterfall`](workbench.md#op-runworkbenchwaterfall) | billable |
|
|
3216
|
+
| POST | `/api/v1/workbench/tables/{table_id}/waterfall/configs/{column_id}/validate-credits` | [`g8.api.workbench.quoteWorkbenchWaterfallRun`](workbench.md#op-quoteworkbenchwaterfallrun) | read |
|
|
3217
|
+
| GET | `/api/v1/workbench/target-fields` | [`g8.api.workbench.listWorkbenchTargetFields`](workbench.md#op-listworkbenchtargetfields) | read |
|
|
3218
|
+
| GET | `/api/v1/workflows` | [`g8.api.workflows.listWorkflows`](workflows.md#op-listworkflows) or `g8.workflows.list()` | read |
|
|
3219
|
+
| POST | `/api/v1/workflows` | [`g8.api.workflows.createWorkflow`](workflows.md#op-createworkflow) or `g8.workflows.create()` | external |
|
|
3220
|
+
| GET | `/api/v1/workflows/dispositions` | [`g8.api.workflows.listDispositions`](workflows.md#op-listdispositions) or `g8.workflows.listDispositions()` | read |
|
|
3221
|
+
| GET | `/api/v1/workflows/executions` | [`g8.api.workflows.listWorkflowExecutions`](workflows.md#op-listworkflowexecutions) | read |
|
|
3222
|
+
| POST | `/api/v1/workflows/executions/approve` | [`g8.api.workflows.approveExecution`](workflows.md#op-approveexecution) | external |
|
|
3223
|
+
| POST | `/api/v1/workflows/executions/bulk-restart` | [`g8.api.workflows.bulkRestartExecutions`](workflows.md#op-bulkrestartexecutions) | external |
|
|
3224
|
+
| POST | `/api/v1/workflows/executions/reject` | [`g8.api.workflows.rejectExecution`](workflows.md#op-rejectexecution) | write |
|
|
3225
|
+
| POST | `/api/v1/workflows/executions/request-changes` | [`g8.api.workflows.requestExecutionChanges`](workflows.md#op-requestexecutionchanges) | external |
|
|
3226
|
+
| GET | `/api/v1/workflows/executions/{execution_id}` | [`g8.api.workflows.getExecution`](workflows.md#op-getexecution) or `g8.workflows.getExecution()` | read |
|
|
3227
|
+
| POST | `/api/v1/workflows/executions/{execution_id}/pause` | [`g8.api.workflows.pauseExecution`](workflows.md#op-pauseexecution) or `g8.workflows.pauseExecution()` | external |
|
|
3228
|
+
| POST | `/api/v1/workflows/executions/{execution_id}/restart` | [`g8.api.workflows.restartExecution`](workflows.md#op-restartexecution) | external |
|
|
3229
|
+
| POST | `/api/v1/workflows/executions/{execution_id}/resume` | [`g8.api.workflows.resumeExecution`](workflows.md#op-resumeexecution) or `g8.workflows.resumeExecution()` | external |
|
|
3230
|
+
| POST | `/api/v1/workflows/executions/{execution_id}/stop` | [`g8.api.workflows.stopExecution`](workflows.md#op-stopexecution) or `g8.workflows.stopExecution()` | external |
|
|
3231
|
+
| GET | `/api/v1/workflows/forms/{form_id}/fields` | [`g8.api.workflows.describeFormFields`](workflows.md#op-describeformfields) or `g8.workflows.listFormFields()` | read |
|
|
3232
|
+
| GET | `/api/v1/workflows/inbox-tags` | [`g8.api.workflows.listInboxTags`](workflows.md#op-listinboxtags) | read |
|
|
3233
|
+
| GET | `/api/v1/workflows/integrations` | [`g8.api.workflows.listWorkflowIntegrations`](workflows.md#op-listworkflowintegrations) | read |
|
|
3234
|
+
| GET | `/api/v1/workflows/integrations/linkedin/senders` | [`g8.api.workflows.listLinkedinSenders`](workflows.md#op-listlinkedinsenders) | read |
|
|
3235
|
+
| GET | `/api/v1/workflows/integrations/roam/groups` | [`g8.api.workflows.listRoamGroups`](workflows.md#op-listroamgroups) or `g8.workflows.listRoamGroups()` | read |
|
|
3236
|
+
| GET | `/api/v1/workflows/integrations/roam/users` | [`g8.api.workflows.listRoamUsers`](workflows.md#op-listroamusers) or `g8.workflows.listRoamUsers()` | read |
|
|
3237
|
+
| GET | `/api/v1/workflows/integrations/slack/channels` | [`g8.api.workflows.listSlackChannels`](workflows.md#op-listslackchannels) or `g8.workflows.listSlackChannels()` | read |
|
|
3238
|
+
| GET | `/api/v1/workflows/integrations/slack/users` | [`g8.api.workflows.listSlackUsers`](workflows.md#op-listslackusers) or `g8.workflows.listSlackUsers()` | read |
|
|
3239
|
+
| DELETE | `/api/v1/workflows/integrations/{provider_name}` | [`g8.api.workflows.deleteWorkflowIntegration`](workflows.md#op-deleteworkflowintegration) | destructive |
|
|
3240
|
+
| GET | `/api/v1/workflows/integrations/{provider_name}` | [`g8.api.workflows.getWorkflowIntegration`](workflows.md#op-getworkflowintegration) | read |
|
|
3241
|
+
| POST | `/api/v1/workflows/integrations/{provider_name}` | [`g8.api.workflows.saveWorkflowIntegration`](workflows.md#op-saveworkflowintegration) | write |
|
|
3242
|
+
| POST | `/api/v1/workflows/integrations/{provider_name}/test` | [`g8.api.workflows.testIntegrationCredential`](workflows.md#op-testintegrationcredential) | external |
|
|
3243
|
+
| GET | `/api/v1/workflows/mcp-servers` | [`g8.api.workflows.listMcpServers`](workflows.md#op-listmcpservers) or `g8.workflows.listMcpServers()` | read |
|
|
3244
|
+
| GET | `/api/v1/workflows/node-stats` | [`g8.api.workflows.getWorkflowNodeStats`](workflows.md#op-getworkflownodestats) | read |
|
|
3245
|
+
| GET | `/api/v1/workflows/node-types/schema` | [`g8.api.workflows.getNodeTypesSchema`](workflows.md#op-getnodetypesschema) or `g8.workflows.nodeTypes()` | read |
|
|
3246
|
+
| POST | `/api/v1/workflows/plan` | [`g8.api.workflows.planInlineWorkflow`](workflows.md#op-planinlineworkflow) | read |
|
|
3247
|
+
| GET | `/api/v1/workflows/run-summary` | [`g8.api.workflows.getWorkflowRunSummary`](workflows.md#op-getworkflowrunsummary) | read |
|
|
3248
|
+
| GET | `/api/v1/workflows/stats/executions` | [`g8.api.workflows.getExecutionStats`](workflows.md#op-getexecutionstats) | read |
|
|
3249
|
+
| GET | `/api/v1/workflows/stats/trigger-activity` | [`g8.api.workflows.getTriggerActivity`](workflows.md#op-gettriggeractivity) | read |
|
|
3250
|
+
| POST | `/api/v1/workflows/validate` | [`g8.api.workflows.validateWorkflow`](workflows.md#op-validateworkflow) or `g8.workflows.validate()` | external |
|
|
3251
|
+
| GET | `/api/v1/workflows/workbenches` | [`g8.api.workflows.listWorkbenches`](workflows.md#op-listworkbenches) | read |
|
|
3252
|
+
| POST | `/api/v1/workflows/workbenches` | [`g8.api.workflows.createWorkbench`](workflows.md#op-createworkbench) | external |
|
|
3253
|
+
| DELETE | `/api/v1/workflows/{action_id}` | [`g8.api.workflows.deleteWorkflow`](workflows.md#op-deleteworkflow) or `g8.workflows.delete()` | destructive |
|
|
3254
|
+
| GET | `/api/v1/workflows/{action_id}` | [`g8.api.workflows.getWorkflow`](workflows.md#op-getworkflow) or `g8.workflows.get()` | read |
|
|
3255
|
+
| PUT | `/api/v1/workflows/{action_id}` | [`g8.api.workflows.updateWorkflow`](workflows.md#op-updateworkflow) or `g8.workflows.update()` | external |
|
|
3256
|
+
| POST | `/api/v1/workflows/{action_id}/execute` | [`g8.api.workflows.executeWorkflow`](workflows.md#op-executeworkflow) or `g8.workflows.execute()` | external |
|
|
3257
|
+
| POST | `/api/v1/workflows/{action_id}/plan` | [`g8.api.workflows.planWorkflow`](workflows.md#op-planworkflow) | read |
|
|
3258
|
+
| GET | `/api/v1/workflows/{action_id}/runs/recent` | [`g8.api.workflows.listRecentWorkflowRuns`](workflows.md#op-listrecentworkflowruns) | read |
|
|
3259
|
+
| POST | `/api/v1/workflows/{action_id}/trigger-reset` | [`g8.api.workflows.resetTriggerCursor`](workflows.md#op-resettriggercursor) or `g8.workflows.resetTrigger()` | external |
|
|
3260
|
+
| GET | `/api/v1/workflows/{action_id}/trigger-status` | [`g8.api.workflows.getTriggerStatus`](workflows.md#op-gettriggerstatus) or `g8.workflows.getTriggerStatus()` | read |
|