# API Reference

> Complete REST API reference for Dailybot: endpoints, parameters, request/response examples for check-ins, users, teams, messaging, and more.

Language: en
Canonical: https://www.dailybot.com/developers/api
Markdown: send header `Accept: text/markdown` on any URL to receive Markdown instead of HTML.
Last Updated: 2026-07-10

---

# API reference

The Dailybot REST API allows you to programmatically manage check-ins, users, teams, messages, and more. All endpoints accept and return JSON, use standard HTTP methods, and support API key authentication or CLI Bearer tokens.

## Base URL

```
https://api.dailybot.com/v1/
```

> **Authentication:** Every request requires either an API key (`X-API-KEY` header) or a CLI Bearer token (`Authorization: Bearer …`). API keys work on **all** `/v1/` endpoints. CLI Bearer tokens are subject to free-plan allowlists and role-based scoping. See [Authentication](/developers/authentication) for the full auth method matrix.

## Resources

The API is organized around the following resources. Click on a resource to see all available endpoints, parameters, and response examples.

| Resource | Endpoints | Methods | Description |
|----------|-----------|---------|-------------|
| [Users](/developers/api/users) | 5 | GET, PATCH | Read the org directory, look up user profiles, and update user metadata. |
| [Organization](/developers/api/organization) | 1 | GET | Read the organization the current credential is scoped to. |
| [Teams](/developers/api/teams) | 7 | GET, POST, PATCH, DELETE | List teams, manage team membership, add or remove members. |
| [Invitations](/developers/api/invitations) | 6 | GET, POST, PUT, DELETE | Invite users (platform or guest), list and manage pending invitations. |
| [Check-ins](/developers/api/check-ins) | 6 | GET, POST, PATCH, PUT | Create, retrieve, list check-ins, and manage check-in responses. |
| [Forms](/developers/api/forms) | 8 | GET, POST, PATCH, DELETE | List forms, submit responses, transition responses through workflow states, read audit history. |
| [Templates](/developers/api/templates) | 2 | GET | Retrieve pre-built check-in templates with rendered question variables. |
| [Messaging](/developers/api/messaging) | 3 | POST | Send bot messages to users, teams, and channels; send emails; open conversations. |
| [Kudos](/developers/api/kudos) | 4 | GET, POST | Give kudos, list kudos, org-wide stats, wall of fame leaderboard. |
| [Mood Tracking](/developers/api/mood) | 1 | POST | Track team mood entries for wellbeing signal. |
| [Important Dates](/developers/api/important-dates) | 2 | GET | List and retrieve important dates (birthdays, anniversaries). |
| [Workflows](/developers/api/workflows) | 5 | GET, POST, PATCH, DELETE | Create, retrieve, update, and delete automated workflows. |
| [Webhooks](/developers/api/webhooks) | 2 | POST | Create webhook subscriptions and request sample event payloads. |
| [Agents](/developers/api/agents) | 14 | GET, POST, DELETE | Full agent surface: reports, health, messages, email, webhook, claim, and self-registration. |
| [OAuth2](/developers/api/oauth2) | 2 | GET, POST | OAuth2 authorization and token endpoints for third-party apps. |
| [Integrations](/developers/api/integrations) | 2 | POST | Event and webhook callbacks used by first-party integrations. |
| [Commands Platform](/developers/api/commands-platform) | 14 | GET, POST, PUT, DELETE | Scheduling, storage, event subscriptions, activity feed, exchange tokens. |
| [CLI (auth)](/developers/api/cli) | 7 | GET, POST | CLI-only OTP authentication endpoints and status. |

## Common patterns

### Pagination

All list endpoints return the standard pagination envelope:

```json
{
  "count": 152,
  "next": "https://api.dailybot.com/v1/...?page=2&page_size=50",
  "previous": null,
  "results": [...]
}
```

Use `page` (1-indexed) and `page_size` (default 25, max 100) to navigate. Legacy `limit`/`offset` aliases are supported. Walk `next` until it is `null`. Full details at [/developers/conventions#pagination](/developers/conventions#pagination).

### Search and date range

Most list endpoints support `?search=<term>` (case-insensitive substring, max 256 chars) and `?start_date` / `?end_date` (`YYYY-MM-DD`, caller timezone) filters. See [/developers/conventions#search](/developers/conventions#search) and [/developers/conventions#date-range](/developers/conventions#date-range).

### Error codes

The API uses standard HTTP status codes. Every error response carries a machine-readable `code` field — dispatch on `code`, never parse the prose. Full code reference at [/developers/errors#machine-codes](/developers/errors#machine-codes).

| Code | Status | Description |
|------|--------|-------------|
| 200 | OK | Request succeeded |
| 201 | Created | Resource created successfully |
| 204 | No Content | Request succeeded, no response body |
| 400 | Bad Request | Invalid request body or parameters — check `code` field |
| 401 | Unauthorized | Missing or invalid credential |
| 403 | Forbidden | Plan gate, capability gate, or role restriction — check `code` field |
| 404 | Not Found | Resource not found |
| 429 | Too Many Requests | Rate limit exceeded — honor `Retry-After` header |
| 500 | Server Error | Internal server error — retry with backoff |

### Rate limits

Named scopes per credential per hour. Two endpoints on free plans have additional per-day caps (50/day for agent-reports, 20/day for send-email). See [/developers/rate-limits](/developers/rate-limits) for details.

### Request format

```bash
curl "https://api.dailybot.com/v1/{endpoint}/" \
  -H "X-API-KEY: $DAILYBOT_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json"
```

---

## Developer portal navigation

**Getting Started**

- [Overview](/developers)
- [Quick start](/developers/getting-started)
- [Authentication](/developers/authentication)

**API Reference**

- [API Overview](/developers/api) (this page)
- [Users](/developers/api/users)
- [Organization](/developers/api/organization)
- [Teams](/developers/api/teams)
- [Invitations](/developers/api/invitations)
- [Check-ins](/developers/api/check-ins)
- [Forms](/developers/api/forms)
- [Report channels](/developers/api/report-channels)
- [Templates](/developers/api/templates)
- [Kudos](/developers/api/kudos)
- [Mood tracking](/developers/api/mood)
- [Important dates](/developers/api/important-dates)
- [Messaging](/developers/api/messaging)
- [Automations](/developers/api/workflows)
- [Webhooks](/developers/api/webhooks)
- [Commands platform](/developers/api/commands-platform)
- [Agents](/developers/api/agents)
- [OAuth2](/developers/api/oauth2)
- [Integrations](/developers/api/integrations)
- [CLI](/developers/api/cli)

**API guides**

- [Errors & Status Codes](/developers/errors)
- [Rate Limits](/developers/rate-limits)
- [Conventions](/developers/conventions)
- [API Changelog](/developers/api-changelog)
- [Recipes](/developers/recipes)

**Developer Features**

- [Custom commands](/developers/custom-commands)
- [Serverless commands](/developers/serverless)
- [Webhooks & events](/developers/webhooks)
- [Automation API trigger](/developers/workflow-trigger)
- [Activity API](/developers/activity-api)

**CLI**

- [Overview](/developers/cli)
- [Authentication](/developers/cli-authentication)
- [Command reference](/developers/cli-reference)
- [CI/CD recipes](/developers/cli-ci-cd)
- [Configuration](/developers/cli-configuration)
- [Troubleshooting](/developers/cli-troubleshooting)

**Agent Skill**

- [Overview](/developers/agent-skill)
- [Skills catalog](/skills)

---

## Site navigation

**Product:**
- [Home](/)
- [Product](/product)
- [Pricing](/pricing)
- [Enterprise](/enterprise)
- [Integrations](/integrations)
- [Templates](/templates)

**Resources:**
- [Blog](/blog)
- [Academy](/academy)
- [Changelog](/changelog)
- [Help Center](/help)
- [Developers](/developers)
- [Agents](/agents)

**Company:**
- [About](/about)
- [Careers](/careers)
- [Security](/security)
- [Contact Sales](/demo)

**Connect:**
- [LinkedIn](https://www.linkedin.com/company/dailybot/)
- [X/Twitter](https://twitter.com/dailybot)
- [GitHub](https://github.com/Dailybot-Inc)
- [YouTube](https://www.youtube.com/channel/UC3uM9V52vwX7e3vQpCc4qvA)

