Skip to content

API reference

Public REST API v1, generated from the running API (version e1bcd4be52e7). Send an API key from Developers in your portal as Authorization: Bearer dice_live_…. Try requests in the interactive reference, or start with the getting started guide, webhooks and the TypeScript SDK.

Account

  • GET/api/v1/me

    200: The calling key, its scopes and its business

    Parameters: Dice-Business (header)

  • GET/api/v1/usage

    200: Usage this billing period against the plan

    Parameters: Dice-Business (header)

  • GET/api/v1/businesses

    200: Agency keys: the agency’s client businesses

    Parameters: cursor (query), limit (query), Dice-Business (header)

  • GET/api/v1/businesses/{id}

    Parameters: id (path, required), Dice-Business (header)

Appointments

  • GET/api/v1/appointments

    200: Appointments, newest first

    Parameters: cursor (query), limit (query), status (query), lead_id (query), from (query), to (query), Dice-Business (header)

  • POST/api/v1/appointments

    201: Booked, or requested when a calendar is unavailable

    Parameters: Dice-Business (header)

  • GET/api/v1/appointments/{id}

    Parameters: id (path, required), Dice-Business (header)

  • GET/api/v1/availability

    200: Free start times for a service

    Parameters: service (query), from (query), days (query), Dice-Business (header)

  • POST/api/v1/appointments/{id}/cancel

    Parameters: id (path, required), Dice-Business (header)

Conversations

  • GET/api/v1/conversations

    200: Conversations, newest first

    Parameters: cursor (query), limit (query), lead_id (query), channel (query), requires_human (query), Dice-Business (header)

  • GET/api/v1/conversations/{id}

    Parameters: id (path, required), Dice-Business (header)

  • GET/api/v1/conversations/{id}/messages

    200: Messages, newest first (internal notes excluded)

    Parameters: id (path, required), cursor (query), limit (query), Dice-Business (header)

Knowledge

  • GET/api/v1/knowledge/sources

    Parameters: cursor (query), limit (query), Dice-Business (header)

  • POST/api/v1/knowledge/sources

    201: Created; the first crawl is queued

    Parameters: Dice-Business (header)

  • GET/api/v1/knowledge/qa

    Parameters: cursor (query), limit (query), Dice-Business (header)

  • POST/api/v1/knowledge/qa

    201: Stored and indexed; the agent can use it at once

    Parameters: Dice-Business (header)

  • DELETE/api/v1/knowledge/qa/{id}

    Parameters: id (path, required), Dice-Business (header)

Leads

  • GET/api/v1/leads

    200: Leads, newest first

    Parameters: cursor (query), limit (query), status (query), updated_since (query), email (query), phone (query), Dice-Business (header)

  • POST/api/v1/leads

    202: Accepted. Poll GET /v1/intakes/{intake_id} for the lead id.

    Parameters: Dice-Business (header)

  • GET/api/v1/leads/{id}

    Parameters: id (path, required), Dice-Business (header)

  • PATCH/api/v1/leads/{id}

    Parameters: id (path, required), Dice-Business (header)

  • GET/api/v1/intakes/{id}

    Parameters: id (path, required), Dice-Business (header)

  • POST/api/v1/leads/{id}/status

    Parameters: id (path, required), Dice-Business (header)

Webhooks

  • GET/api/v1/events

    200: Every event a webhook can subscribe to

    Parameters: Dice-Business (header)

  • GET/api/v1/webhooks

    Parameters: Dice-Business (header)

  • POST/api/v1/webhooks

    Parameters: Dice-Business (header)

  • GET/api/v1/webhooks/{id}

    Parameters: id (path, required), Dice-Business (header)

  • PATCH/api/v1/webhooks/{id}

    Parameters: id (path, required), Dice-Business (header)

  • DELETE/api/v1/webhooks/{id}

    Parameters: id (path, required), Dice-Business (header)

  • POST/api/v1/webhooks/{id}/rotate-secret

    200: The new secret; the old one stops working at once

    Parameters: id (path, required), Dice-Business (header)

  • POST/api/v1/webhooks/{id}/test

    200: Sends a webhook.test event now

    Parameters: id (path, required), Dice-Business (header)

  • GET/api/v1/webhooks/{id}/deliveries

    200: Delivery log, newest first

    Parameters: id (path, required), cursor (query), limit (query), status (query), Dice-Business (header)

  • POST/api/v1/webhook-deliveries/{id}/replay

    200: Sends the same event again now

    Parameters: id (path, required), Dice-Business (header)

  • POST/api/v1/hooks

    201: REST-hook subscription (Zapier, Make, n8n)

    Parameters: Dice-Business (header)

  • DELETE/api/v1/hooks/{id}

    Parameters: id (path, required), Dice-Business (header)

  • GET/api/v1/hooks/samples/{event}

    200: One sample payload, for trigger setup screens

    Parameters: event (path, required), Dice-Business (header)