# Invitations

> Invite users (platform or guest), list and manage pending invitations.

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

---

# Invitations

Invite users (platform or guest), list and manage pending invitations. Requires Org Administrator role.

## Endpoints summary

| Method | Endpoint | Description |
|--------|----------|-------------|
| POST | `/v1/invite-user/` | Invite a platform user |
| GET | `/v1/pending-invitations/` | List pending platform invitations |
| GET | `/v1/pending-invitations/{id}/` | Get a pending invitation |
| DELETE | `/v1/pending-invitations/{id}/` | Cancel a pending invitation |
| GET | `/v1/pending-invitations/all/` | List all pending invitations (platform + guest) |
| GET | `/v1/pending-invitations/guests/` | List pending guest invitations |
| GET | `/v1/pending-invitations/guests/{id}/` | Get a pending guest invitation |
| DELETE | `/v1/pending-invitations/guests/{id}/` | Cancel a pending guest invitation |

---

## POST /v1/invite-user/

Invites a user to join the organization.

### Body parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `email` | string (email) | Yes | Email address of the user to invite. |
| `role` | string | No | Role for the new user: `member` (default) or `admin`. |
| `teams` | array of strings | No | Team UUIDs to add the user to upon accepting. |

```bash
curl -X POST "https://api.dailybot.com/v1/invite-user/" \
  -H "X-API-KEY: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "newmember@company.com",
    "role": "member",
    "teams": ["team-uuid-1"]
  }'
```

**Response (201 Created):**

```json
{
  "id": "inv-uuid",
  "email": "newmember@company.com",
  "role": "member",
  "status": "pending",
  "created_at": "2026-04-06T10:00:00Z"
}
```

---

## GET /v1/pending-invitations/

Returns all pending platform invitations.

### Query parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `page` | integer | No | Page number (1-based). |
| `page_size` | integer | No | Results per page (max 100). |

```bash
curl -X GET "https://api.dailybot.com/v1/pending-invitations/" \
  -H "X-API-KEY: your_api_key"
```

**Response (200 OK):**

```json
{
  "count": 3,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "inv-uuid",
      "email": "newmember@company.com",
      "role": "member",
      "status": "pending",
      "created_at": "2026-04-06T10:00:00Z"
    }
  ]
}
```

---

## DELETE /v1/pending-invitations/{id}/

Cancels a pending invitation.

```bash
curl -X DELETE "https://api.dailybot.com/v1/pending-invitations/inv-uuid/" \
  -H "X-API-KEY: your_api_key"
```

**Response (204 No Content)**

---

## GET /v1/pending-invitations/guests/

Returns pending guest invitations for the organization.

```bash
curl -X GET "https://api.dailybot.com/v1/pending-invitations/guests/" \
  -H "X-API-KEY: your_api_key"
```

## Endpoints in this group

Invite up to 100 users per call, list pending invitations, and manage guest invites. API-key only.

| Method | Endpoint | Description |
|--------|----------|-------------|
| POST | `/v1/invite-user/` | Invite users (API-Key only) |
| GET | `/v1/pending-invitations/` | List pending invitations (API-Key only) |
| GET | `/v1/pending-invitations/{id}/` | Retrieve a pending invitation (API-Key only) |
| PUT | `/v1/pending-invitations/{id}/` | Replace a pending invitation (API-Key only) |
| DELETE | `/v1/pending-invitations/{id}/` | Revoke a pending invitation (API-Key only) |
| GET | `/v1/pending-invitations/guests/` | List pending guest invitations (API-Key only) |

### POST `/v1/invite-user/`

**Invite users (API-Key only)**

Max 100 identifiers per call. Body: users_identifiers, optional is_guest_account_invite, joinable_team_uuids, joinable_followup_uuids.

- **Auth:** API key (`X-API-KEY`)
- **Rate limit:** `default`
- **Pagination:** No pagination

#### Error codes

| Status | When |
|--------|------|
| `401` | Missing/invalid/expired credential |
| `403` | Authenticated but not permitted |
| `429` | Throttled - Retry-After header set |
| `400` | Validation error |

#### Example (curl)

```bash
curl -sS -X POST 'https://api.dailybot.com/v1/invite-user/' -H 'X-API-KEY: $DAILYBOT_API_KEY'
```

### GET `/v1/pending-invitations/`

**List pending invitations (API-Key only)**

List pending invitations (API-Key only)

- **Auth:** API key (`X-API-KEY`)
- **Rate limit:** `default`
- **Pagination:** Page-number pagination

#### Error codes

| Status | When |
|--------|------|
| `401` | Missing/invalid/expired credential |
| `403` | Authenticated but not permitted |
| `429` | Throttled - Retry-After header set |

#### Example (curl)

```bash
curl -sS -X GET 'https://api.dailybot.com/v1/pending-invitations/' -H 'X-API-KEY: $DAILYBOT_API_KEY'
```

### GET `/v1/pending-invitations/{id}/`

**Retrieve a pending invitation (API-Key only)**

Retrieve a pending invitation (API-Key only)

- **Auth:** API key (`X-API-KEY`)
- **Rate limit:** `default`
- **Pagination:** No pagination

#### Path parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `id` | string (uuid) | Yes | — |

#### Error codes

| Status | When |
|--------|------|
| `401` | Missing/invalid/expired credential |
| `403` | Authenticated but not permitted |
| `429` | Throttled - Retry-After header set |
| `404` | Not found or not visible |

#### Example (curl)

```bash
curl -sS -X GET 'https://api.dailybot.com/v1/pending-invitations/{id}/' -H 'X-API-KEY: $DAILYBOT_API_KEY'
```

### PUT `/v1/pending-invitations/{id}/`

**Replace a pending invitation (API-Key only)**

Replace a pending invitation (API-Key only)

- **Auth:** API key (`X-API-KEY`)
- **Rate limit:** `default`
- **Pagination:** No pagination

#### Path parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `id` | string (uuid) | Yes | — |

#### Error codes

| Status | When |
|--------|------|
| `401` | Missing/invalid/expired credential |
| `403` | Authenticated but not permitted |
| `429` | Throttled - Retry-After header set |
| `400` | Validation error |
| `404` | Not found or not visible |

#### Example (curl)

```bash
curl -sS -X PUT 'https://api.dailybot.com/v1/pending-invitations/{id}/' -H 'X-API-KEY: $DAILYBOT_API_KEY'
```

### DELETE `/v1/pending-invitations/{id}/`

**Revoke a pending invitation (API-Key only)**

Revoke a pending invitation (API-Key only)

- **Auth:** API key (`X-API-KEY`)
- **Rate limit:** `default`
- **Pagination:** No pagination

#### Path parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `id` | string (uuid) | Yes | — |

#### Error codes

| Status | When |
|--------|------|
| `401` | Missing/invalid/expired credential |
| `403` | Authenticated but not permitted |
| `429` | Throttled - Retry-After header set |
| `404` | Not found or not visible |

#### Example (curl)

```bash
curl -sS -X DELETE 'https://api.dailybot.com/v1/pending-invitations/{id}/' -H 'X-API-KEY: $DAILYBOT_API_KEY'
```

### GET `/v1/pending-invitations/guests/`

**List pending guest invitations (API-Key only)**

List pending guest invitations (API-Key only)

- **Auth:** API key (`X-API-KEY`)
- **Rate limit:** `default`
- **Pagination:** No pagination

#### Error codes

| Status | When |
|--------|------|
| `401` | Missing/invalid/expired credential |
| `403` | Authenticated but not permitted |
| `429` | Throttled - Retry-After header set |

#### Example (curl)

```bash
curl -sS -X GET 'https://api.dailybot.com/v1/pending-invitations/guests/' -H 'X-API-KEY: $DAILYBOT_API_KEY'
```

---

## Developer portal navigation

**Getting Started**

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

**API Reference**

- [API Overview](/developers/api)
- [Users](/developers/api/users)
- [Organization](/developers/api/organization)
- [Teams](/developers/api/teams)
- [Invitations](/developers/api/invitations) (this page)
- [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)