PUBLIC API · V1

Build with Dashspoke

Access workspace data through scoped service-account credentials. The integration API is designed for server-to-server use and keeps sandbox and production data separate.

Base URLhttps://api-go.dashspoke.com/v1

Authentication

Create a service account in your workspace’s Developer settings and grant only the scopes your integration needs. Send its credential as a Bearer token on every request. Credentials are shown only when created or rotated; keep them on your server, never in browser code.

Request example

curl --request GET \
  --url https://api-go.dashspoke.com/v1/integration/me \
  --header 'Authorization: Bearer YOUR_SERVICE_ACCOUNT_KEY' \
  --header 'Accept: application/json'

Use GET /integration/me to confirm the active workspace, environment and scopes before synchronizing data.

Environments

SANDBOX

Test safely

Credentials beginning with dspk_test_ operate on isolated sandbox data. Use them for development and integration tests.

PRODUCTION

Connect live data

Credentials beginning with dspk_live_ access the authorized production workspace. Rotate and revoke them in Developer settings.

Endpoints

These are the public service-account endpoints. Dashboard-only and administrative routes are intentionally excluded.

GET/integration/meAny valid credential

Identify the service account, workspace, environment and scopes.

GET/integration/contactscontacts:read

List up to 100 contacts. Optional q filters results (maximum 200 characters).

GET/integration/conversationsconversations:read

List up to 100 conversations. Optional status is open, snoozed or resolved; optional q filters results.

GET/integration/websiteswebsites:read

List up to 100 websites in the authorized workspace.

Need machine-readable details? Download the OpenAPI 3.1 specification.

Responses and limits

List responses contain data and meta. Authentication failures return 401, missing scopes return 403, invalid filters return 422, and exceeded limits return 429. Errors include a machine-readable code; request IDs can be used when contacting support.

The service-account limit is 600 requests per 60 seconds. Inspect RateLimit-Limit, RateLimit-Remaining and, after a 429, Retry-After. Retry transient failures with bounded exponential backoff.

Webhooks

Configure outbound subscriptions in Developer settings. Verify signatures against the raw request body, enforce the timestamp window, and deduplicate delivery IDs before applying an event. The maintained Go, TypeScript, Python and PHP SDK source under sdk/ includes verification helpers.