Skip to content

Users & Organization

Manage organization members, retrieve user profiles, invite new users, and access organization metadata. The /me/ endpoint returns context about the authenticated API key owner.

Method Endpoint Description
GET /v1/me/ Get the authenticated user
GET /v1/organization/ Get organization metadata
GET /v1/users/ List and search all users
GET /v1/users/{uuid}/ Get a specific user
PATCH /v1/users/{uuid}/ Update a user's profile
POST /v1/invite-user/ Invite users to the organization

Get Context Info

GET /v1/me/

Retrieves contextual information about the authenticated user and their organization.

Query Parameters

Name Type Required Description
include_email boolean Optional Include the user's email in the response. Default: false.
Request
curl -X GET "https://api.dailybot.com/v1/me/" \
  -H "X-API-KEY: your_api_key"
Response 200 OK
json
{
  "uuid": "user-uuid",
  "full_name": "Jane Smith",
  "image": "https://...",
  "role": "admin",
  "is_active": true,
  "bot_enabled": true,
  "timezone": "America/New_York",
  "occupation": "Designer",
  "birth_date": "02-08",
  "chat_platform_data": {},
  "work_days": [0, 1, 2, 3, 4],
  "timeoff_start": null,
  "timeoff_end": null,
  "hour_init_work": "09:00",
  "anniversary": null,
  "organization": {
    "uuid": "org-uuid",
    "name": "Acme Corp",
    "plan_name": "Pro"
  },
  "user": "Jane Smith",
  "organization_uuid": "org-uuid",
  "organization_name": "Acme Corp"
}

Get Organization

GET /v1/organization/

Retrieves the authenticated user's organization metadata.

Request
curl -X GET "https://api.dailybot.com/v1/organization/" \
  -H "X-API-KEY: your_api_key"
Response 200 OK
json
{
  "uuid": "org-uuid",
  "name": "Acme Corp",
  "timezone": "America/New_York",
  "image": "https://...",
  "platform": "slack",
  "chat_platform_data": {},
  "supported_domains": [
    "acme.com"
  ],
  "has_email_password_enabled": true
}

List Users

GET /v1/users/

Returns a paginated list of organization members. Supports filtering and search.

Query Parameters

Name Type Required Description
search string Optional Filter by name, email, or external ID (case-insensitive).
only_active boolean Optional If set, return only active users.
include_email boolean Optional Include email in each user object. Default: false.
limit integer Optional Max results per page (pagination).
offset integer Optional Number of results to skip (pagination).
Request
curl -X GET "https://api.dailybot.com/v1/users/" \
  -H "X-API-KEY: your_api_key"
Response 200 OK
json
{
  "count": 25,
  "next": "https://api.dailybot.com/v1/users/?limit=10&offset=10",
  "previous": null,
  "results": [
    {
      "uuid": "user-uuid",
      "full_name": "Jane Smith",
      "image": "https://...",
      "role": "admin",
      "is_active": true,
      "bot_enabled": true,
      "timezone": "America/New_York",
      "occupation": "Designer",
      "birth_date": "02-08",
      "chat_platform_data": {},
      "work_days": [0, 1, 2, 3, 4],
      "timeoff_start": null,
      "timeoff_end": null,
      "hour_init_work": "09:00",
      "anniversary": null,
      "organization": {
        "uuid": "...",
        "name": "Acme Corp"
      }
    }
  ]
}

Get User

GET /v1/users/{user-uuid}/

Returns a single user by UUID.

Query Parameters

Name Type Required Description
include_email boolean Optional Include email in the response. Default: false.
Request
curl -X GET "https://api.dailybot.com/v1/users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  -H "X-API-KEY: your_api_key"
Response 200 OK
json
{
  "uuid": "user-uuid",
  "full_name": "Jane Smith",
  "image": "https://...",
  "role": "admin",
  "is_active": true,
  "bot_enabled": true,
  "timezone": "America/New_York",
  "occupation": "Designer",
  "birth_date": "02-08",
  "chat_platform_data": {},
  "work_days": [0, 1, 2, 3, 4],
  "timeoff_start": null,
  "timeoff_end": null,
  "hour_init_work": "09:00",
  "anniversary": null,
  "organization": {
    "uuid": "org-uuid",
    "name": "Acme Corp"
  }
}
Response 404 Not Found
json
{
  "detail": "Not found.",
  "code": "not_found"
}

Update User

PATCH /v1/users/{user-uuid}/

Updates a user's profile. Only provided fields are modified.

Body Parameters

Name Type Required Description
full_name string Optional Full name.
occupation string Optional Job title or occupation.
birth_date string Optional Birth date in MM-DD format.
timezone string Optional IANA timezone (e.g. America/New_York).
work_days array of integers Optional Working days (0=Monday, 6=Sunday).
timeoff_start string Optional Time-off start date.
timeoff_end string Optional Time-off end date.
hour_init_work string Optional Work start time (e.g. HH:MM).
active boolean Optional Whether the user is active.
bot_enabled boolean Optional Whether Dailybot is enabled for this user.
Request
curl -X PATCH "https://api.dailybot.com/v1/users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  -H "X-API-KEY: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "full_name": "Jane Smith"
  }'
Response 200 OK
json
{
  "uuid": "user-uuid",
  "full_name": "Jane Smith",
  "image": "https://...",
  "role": "admin",
  "is_active": true,
  "bot_enabled": true,
  "timezone": "America/New_York",
  "occupation": "Designer",
  "birth_date": "02-08",
  "chat_platform_data": {},
  "work_days": [0, 1, 2, 3, 4],
  "timeoff_start": null,
  "timeoff_end": null,
  "hour_init_work": "09:00",
  "anniversary": null,
  "organization": {
    "uuid": "org-uuid",
    "name": "Acme Corp"
  }
}
Response 400 Bad Request
json
{
  "detail": "Birth date has an invalid date format. It must be in MM-DD format.",
  "code": "bad_birth_date_format"
}

Invite User

POST /v1/invite-user/

Invites users to the organization by email or external platform ID. Two flows: platform (default), which invites existing platform users, and guest, which sends email invitations for direct registration.

Body Parameters

Name Type Required Description
users_identifiers array of strings Required Emails or external platform IDs to invite (max 100). Strings with @ are treated as emails; others as external IDs.
is_guest_account_invite boolean Optional If true, use guest flow (email invitations only). Default: false.
joinable_team_uuids array of strings (UUID) Optional Team UUIDs the invited users will join.
joinable_followup_uuids array of strings (UUID) Optional Check-in UUIDs the invited users will join.
Request
curl -X POST "https://api.dailybot.com/v1/invite-user/" \
  -H "X-API-KEY: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "users_identifiers": ["[email protected]"]
  }'
Response 200 OK — Platform flow (default)
json
{
  "dailybot_members": {
    "count": 0,
    "members": []
  },
  "users_invited": {
    "count": 1,
    "members": [
      "[email protected]"
    ]
  },
  "pending_invitations": {
    "count": 0,
    "identifiers": []
  },
  "wrong_users": {
    "count": 0,
    "users_identifiers": []
  }
}
Response 200 OK — Guest flow (is_guest_account_invite: true)
json
{
  "dailybot_members": {
    "count": 0,
    "members": []
  },
  "guests_invited": {
    "count": 1,
    "emails": [
      "[email protected]"
    ]
  },
  "already_invited": {
    "count": 0,
    "emails": []
  },
  "wrong_users": {
    "count": 0,
    "users_identifiers": []
  }
}
Response 400 Bad Request
json
{
  "detail": "users_identifiers is required and cannot be empty",
  "code": "params_validation_error"
}

Info

The API key must belong to an Organization Administrator to invite users. Non-admin keys will receive a 403 Forbidden response.