Skip to content

Users

Read the current authenticated identity, list and search users in the organization directory, retrieve a user by UUID, and update a user's profile. The /me/ endpoint returns context about the caller (user or agent).

See also: Organization (metadata of the organization the credential belongs to) and Invitations (invite new users, manage pending invitations).
MethodEndpointDescription
GET/v1/me/Get the authenticated user
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

Get Context Info

GET/v1/me/API keyCLI Auth

Retrieves contextual information about the authenticated user and their organization.

Query Parameters

NameTypeRequiredDescription
include_emailbooleanOptionalInclude 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"
Response200 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"
}

List Users

GET/v1/users/API keyCLI Auth

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

Query Parameters

NameTypeRequiredDescription
searchstringOptionalFilter by name, email, or external ID (case-insensitive).
only_activebooleanOptionalIf set, return only active users.
include_emailbooleanOptionalInclude email in each user object. Default: false.
limitintegerOptionalMax results per page (pagination).
offsetintegerOptionalNumber of results to skip (pagination).
Request
curl -X GET "https://api.dailybot.com/v1/users/" \
  -H "X-API-KEY: your_api_key"
Response200 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}/API keyCLI Auth

Returns a single user by UUID.

Query Parameters

NameTypeRequiredDescription
include_emailbooleanOptionalInclude 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"
Response200 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"
  }
}
Response404 Not Found
json
{
  "detail": "Not found.",
  "code": "not_found"
}

Update User

PATCH/v1/users/{user-uuid}/API keyCLI Auth

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

Body Parameters

NameTypeRequiredDescription
full_namestringOptionalFull name.
occupationstringOptionalJob title or occupation.
birth_datestringOptionalBirth date in MM-DD format.
timezonestringOptionalIANA timezone (e.g. America/New_York).
work_daysarray of integersOptionalWorking days (0=Monday, 6=Sunday).
timeoff_startstringOptionalTime-off start date.
timeoff_endstringOptionalTime-off end date.
hour_init_workstringOptionalWork start time (e.g. HH:MM).
activebooleanOptionalWhether the user is active.
bot_enabledbooleanOptionalWhether 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"
  }'
Response200 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"
  }
}
Response400 Bad Request
json
{
  "detail": "Birth date has an invalid date format. It must be in MM-DD format.",
  "code": "bad_birth_date_format"
}