API Reference

Platform access for scoped client work

ByteDesk technical access should support the service engagement: portals, reports, automation events, and platform data where the scope calls for it.

Access at a glance

Technical surfaces are useful only when they make the service easier to run, measure, or hand off.

Scoped Access

API and tenant access should be tied to the client, service scope, and operational need.

Workflow Events

Use event-driven workflows for handoffs, reporting, enrichment, and follow-up where appropriate.

Security

Access decisions should be explicit, permissioned, and reviewed as part of the engagement.

Change Control

Technical changes belong in the managed backlog so platform work does not drift from the service goal.

Platform areas

These are the areas most likely to matter when ByteDesk exposes platform access as part of an engagement.

Client Context

Contacts, opportunities, tasks, and service records that support delivery.

AREAContacts
AREAOpportunities
AREATasks
AREAOnboarding

Marketing Work

Reports, audits, campaign context, and content planning surfaces.

AREASEO audits
AREAReports
AREAContent gaps
AREAMarket scans

Software Delivery

Websites, apps, deployment, domains, and project operations.

AREAProjects
AREADeployments
AREADomains
AREAMonitoring

Automation and AI

Workflow events, enrichment, extraction, and assistant-supported jobs.

AREAWorkflow actions
AREAEnrichment
AREAExtraction
AREAAI assistance

Scoped access example

Exact access details are defined during implementation. The shape below is intentionally illustrative.

cURL
curl -X GET https://api.bytedesk.ai/v1/{scoped-resource} \
  -H "Authorization: Bearer SCOPED_TOKEN" \
  -H "Content-Type: application/json"

Common access paths

Tenant portal
client-visible service surfaces
Reports
audits, metrics, work summaries
Webhooks
scoped workflow events
Custom access
defined during implementation

Need technical access?

Start with the service goal, then define the portal, event, report, or custom access the engagement actually needs.