Skip to content
ver .md original

Usuários

Consulte o diretório da organização, obtenha perfis de usuário e atualize metadados. Aceita tanto chaves de API quanto tokens Bearer da CLI.

GET/v1/me/Chave de APICLI AuthOAuth 2.0

Current authenticated identity

Returns the current authenticated user (or agent identity for API-Key requests). Supports include_email query.

Parâmetros de consulta

NomeTipoObrigatórioDescrição
include_emailbooleanOpcionalInclude email in response. Default false.

Erros

StatusQuando
401Missing/invalid/expired credential
403Authenticated but not permitted
429Throttled - Retry-After header set
curl -sS -X GET 'https://api.dailybot.com/v1/me/' -H 'X-API-KEY: $DAILYBOT_API_KEY'

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

GET/v1/users/Chave de APICLI AuthPaginação por número de página

List organization members

Paginated list of users. Supports search, only_active, include_email.

Parâmetros de consulta

NomeTipoObrigatórioDescrição
searchstringOpcionalFilter by name, email, or external ID (case-insensitive).
only_activebooleanOpcionalIf set, return only active users.
include_emailbooleanOpcionalInclude email in each user object.
pageintegerOpcionalPage number (page-number pagination).
page_sizeintegerOpcionalPage size (default 20, max 100).

Erros

StatusQuando
401Missing/invalid/expired credential
403Authenticated but not permitted
429Throttled - Retry-After header set
curl -sS -X GET 'https://api.dailybot.com/v1/users/' -H 'X-API-KEY: $DAILYBOT_API_KEY'

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

GET/v1/users/{uuid}/Chave de APICLI Auth

Retrieve a user by UUID

Retrieves a single user by their UUID.

Parâmetros de rota

NomeTipoObrigatórioDescrição
uuidstring (uuid)Obrigatório

Parâmetros de consulta

NomeTipoObrigatórioDescrição
include_emailbooleanOpcional

Erros

StatusQuando
401Missing/invalid/expired credential
403Authenticated but not permitted
429Throttled - Retry-After header set
404Not found or not visible
curl -sS -X GET 'https://api.dailybot.com/v1/users/{uuid}/' -H 'X-API-KEY: $DAILYBOT_API_KEY'

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

PATCH/v1/users/{uuid}/Chave de APICLI Auth

Update a user

Partially update a user profile.

Parâmetros de rota

NomeTipoObrigatórioDescrição
uuidstring (uuid)Obrigatório

Erros

StatusQuando
401Missing/invalid/expired credential
403Authenticated but not permitted
429Throttled - Retry-After header set
400Validation error
404Not found or not visible
curl -sS -X PATCH 'https://api.dailybot.com/v1/users/{uuid}/' -H 'X-API-KEY: $DAILYBOT_API_KEY'

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

PATCH/v1/users/{uuid}/update-metadata/Chave de APICLI Auth

Update user metadata

Merge arbitrary key/value metadata onto a user.

Parâmetros de rota

NomeTipoObrigatórioDescrição
uuidstring (uuid)Obrigatório

Erros

StatusQuando
401Missing/invalid/expired credential
403Authenticated but not permitted
429Throttled - Retry-After header set
400Validation error
404Not found or not visible
curl -sS -X PATCH 'https://api.dailybot.com/v1/users/{uuid}/update-metadata/' -H 'X-API-KEY: $DAILYBOT_API_KEY'

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

GET/v1/me/dashboard-preferences/{surface}/Chave de APICLI AuthOAuth 2.0

Obter preferências do dashboard

Retorna os últimos filtros aplicados para uma superfície (forms_home, workflows_home, followups_home). Sem preferência → 200 com filters vazios.

Parâmetros de rota

NomeTipoObrigatórioDescrição
surfacestringObrigatório

Resposta

{
  "surface": "string (forms_home | workflows_home | followups_home)",
  "schema_version": "integer",
  "filters": "object",
  "updated_at": "string | null (ISO-8601)"
}

Erros

StatusQuando
401Credencial ausente, inválida ou expirada
403Autenticado mas sem permissão
429Limitado — cabeçalho Retry-After presente
404not_found — superfície não suportada
curl -sS -X GET 'https://api.dailybot.com/v1/me/dashboard-preferences/forms_home/' \
  -H 'X-API-KEY: $DAILYBOT_API_KEY'

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

  • Não exige elegibilidade de Etiquetas. Quando Labels indisponíveis, filtros de etiqueta podem ser omitidos com aviso labels_feature_unavailable.
PUT/v1/me/dashboard-preferences/{surface}/Chave de APICLI AuthOAuth 2.0

Salvar preferências do dashboard

Cria ou atualiza os últimos filtros aplicados para uma superfície.

Parâmetros de rota

NomeTipoObrigatórioDescrição
surfacestringObrigatório

Corpo da requisição

{
  "schema_version": 1,
  "filters": "object (canonical)",
  "payload": "object (optional legacy alias; filters wins when both are sent)"
}

Erros

StatusQuando
401Credencial ausente, inválida ou expirada
403Autenticado mas sem permissão
400invalid_preference_payload — corpo inválido (schema_version / filters)
429Limitado — cabeçalho Retry-After presente
404not_found — superfície não suportada
curl -sS -X PUT 'https://api.dailybot.com/v1/me/dashboard-preferences/forms_home/' \
  -H 'X-API-KEY: $DAILYBOT_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"schema_version": 1, "filters": {}}'

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

  • Não exige elegibilidade de Etiquetas. Superfície não suportada → 404 not_found; corpo malformado → 400 invalid_preference_payload.
DELETE/v1/me/dashboard-preferences/{surface}/Chave de APICLI AuthOAuth 2.0

Excluir preferências do dashboard

Limpa os últimos filtros aplicados para uma superfície. 204 idempotente.

Parâmetros de rota

NomeTipoObrigatórioDescrição
surfacestringObrigatório

Erros

StatusQuando
401Credencial ausente, inválida ou expirada
403Autenticado mas sem permissão
429Limitado — cabeçalho Retry-After presente
404not_found — superfície não suportada
curl -sS -X DELETE 'https://api.dailybot.com/v1/me/dashboard-preferences/forms_home/' \
  -H 'X-API-KEY: $DAILYBOT_API_KEY'

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

  • Não exige elegibilidade de Etiquetas. Idempotente: sem preferência ainda retorna 204.
GET/v1/me/saved-views/Chave de APICLI AuthOAuth 2.0

Listar visões salvas

Lista as visões salvas do chamador. Filtro opcional por superfície.

Parâmetros de consulta

NomeTipoObrigatórioDescrição
surfacestringOpcionalFiltra por superfície.

Resposta

{
  "results": "array<{ uuid, surface, name, schema_version, filters, created_at, updated_at }>"
}

Erros

StatusQuando
401Credencial ausente, inválida ou expirada
403Autenticado mas sem permissão
400invalid_preference_payload — query inválida (ex. superfície não suportada)
429Limitado — cabeçalho Retry-After presente
curl -sS -X GET 'https://api.dailybot.com/v1/me/saved-views/' \
  -H 'X-API-KEY: $DAILYBOT_API_KEY'

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

  • Não exige elegibilidade de Etiquetas. Quando Labels indisponíveis, filtros de etiqueta podem ser omitidos com aviso labels_feature_unavailable.
POST/v1/me/saved-views/Chave de APICLI AuthOAuth 2.0

Criar visão salva

Cria uma visão salva com nome para uma superfície.

Corpo da requisição

{
  "surface": "string",
  "name": "string",
  "schema_version": 1,
  "filters": "object (canonical)",
  "payload": "object (optional legacy alias; filters wins when both are sent)"
}

Erros

StatusQuando
401Credencial ausente, inválida ou expirada
403Autenticado mas sem permissão
400invalid_preference_payload — corpo inválido (ex. superfície não suportada)
429Limitado — cabeçalho Retry-After presente
409duplicate_name — já existe uma visão com esse nome nesta superfície
curl -sS -X POST 'https://api.dailybot.com/v1/me/saved-views/' \
  -H 'X-API-KEY: $DAILYBOT_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"surface": "forms_home", "name": "My view", "schema_version": 1, "filters": {}}'

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

  • Não exige elegibilidade de Etiquetas. Quando Labels indisponíveis, filtros de etiqueta podem ser omitidos com aviso labels_feature_unavailable.
GET/v1/me/saved-views/{view_uuid}/Chave de APICLI AuthOAuth 2.0

Obter visão salva

Obtém uma visão salva por UUID.

Parâmetros de rota

NomeTipoObrigatórioDescrição
view_uuidstring (uuid)Obrigatório

Resposta

{
  "uuid": "string (uuid)",
  "surface": "string",
  "name": "string",
  "schema_version": "integer",
  "filters": "object",
  "created_at": "string (ISO-8601)",
  "updated_at": "string (ISO-8601)"
}

Erros

StatusQuando
401Credencial ausente, inválida ou expirada
403Autenticado mas sem permissão
429Limitado — cabeçalho Retry-After presente
404Superfície não suportada ou visão não encontrada
curl -sS -X GET 'https://api.dailybot.com/v1/me/saved-views/{view_uuid}/' \
  -H 'X-API-KEY: $DAILYBOT_API_KEY'

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

  • Não exige elegibilidade de Etiquetas. Quando Labels indisponíveis, filtros de etiqueta podem ser omitidos com aviso labels_feature_unavailable.
PATCH/v1/me/saved-views/{view_uuid}/Chave de APICLI AuthOAuth 2.0

Atualizar visão salva

Atualiza o nome ou os filtros de uma visão salva.

Parâmetros de rota

NomeTipoObrigatórioDescrição
view_uuidstring (uuid)Obrigatório

Corpo da requisição

{
  "name": "string (optional)",
  "filters": "object (optional, canonical)",
  "payload": "object (optional legacy alias; filters wins when both are sent)"
}

Erros

StatusQuando
401Credencial ausente, inválida ou expirada
403Autenticado mas sem permissão
429Limitado — cabeçalho Retry-After presente
404Superfície não suportada ou visão não encontrada
curl -sS -X PATCH 'https://api.dailybot.com/v1/me/saved-views/{view_uuid}/' \
  -H 'X-API-KEY: $DAILYBOT_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"name": "Renamed view", "filters": {}}'

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

  • Não exige elegibilidade de Etiquetas. Quando Labels indisponíveis, filtros de etiqueta podem ser omitidos com aviso labels_feature_unavailable.
DELETE/v1/me/saved-views/{view_uuid}/Chave de APICLI AuthOAuth 2.0

Excluir visão salva

Exclui uma visão salva.

Parâmetros de rota

NomeTipoObrigatórioDescrição
view_uuidstring (uuid)Obrigatório

Erros

StatusQuando
401Credencial ausente, inválida ou expirada
403Autenticado mas sem permissão
429Limitado — cabeçalho Retry-After presente
404Superfície não suportada ou visão não encontrada
curl -sS -X DELETE 'https://api.dailybot.com/v1/me/saved-views/{view_uuid}/' \
  -H 'X-API-KEY: $DAILYBOT_API_KEY'

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

  • Não exige elegibilidade de Etiquetas. Quando Labels indisponíveis, filtros de etiqueta podem ser omitidos com aviso labels_feature_unavailable.

Usuários e Organização

Gerencie usuários, obtenha informações de contexto (/me), recupere detalhes da organização, atualize perfis e metadados, e convide membros.

Resumo de endpoints

Método Endpoint Descrição
GET /v1/me/ Informações do usuário autenticado + organização
GET /v1/organization/ Detalhes da organização
GET /v1/users/ Listar todos os usuários
GET /v1/users/{uuid}/ Obter um usuário específico
PATCH /v1/users/{uuid}/ Atualizar um usuário
POST /v1/invite-user/ Convidar um usuário (ver API de Convites)

Personalização

Estado privado por usuário em /v1/me/.... Não exige elegibilidade de Etiquetas: qualquer membro autenticado pode usar preferências, visões salvas e Featured.

Métodos Rota Uso
GET/PUT/DELETE /v1/me/dashboard-preferences/{surface}/ Últimos filtros para forms_home, workflows_home ou followups_home
GET/POST /v1/me/saved-views/ Listar ou criar visões salvas
GET/PATCH/DELETE /v1/me/saved-views/{view_uuid}/ Gerenciar uma visão
GET /v1/me/featured/?entity_type= Listar UUID Featured (forms, automations, checkins)
PUT /v1/me/featured/{entity_type}/{entity_uuid}/ Alternar Featured ({"featured": true|false})
POST /v1/me/featured/batch/ Featured em lote

Preferência vazia: GET /v1/me/dashboard-preferences/{surface}/ sem estado salvo responde 200:

{"surface": "forms_home", "schema_version": 1, "filters": {}, "updated_at": null}

DELETE de preferências é idempotente (204). Escritas aceitam filters canônico; o legado payload ainda é aceito (filters vence se ambos forem enviados).

Quando Etiquetas estão indisponíveis, preferências podem manter filtros de etiqueta em repouso, mas as respostas os omitem com o aviso labels_feature_unavailable.

Featured é privado por usuáriois_featured nas listagens reflete apenas o chamador.


GET /v1/users/

Retorna todos os usuários da organização. Paginado (ordenação padrão: full_name).

Parâmetros de query

Nome Tipo Padrão Descrição
page integer 1 Número de página. offset aceito como alias.
page_size integer 50 Itens por página (máx. 200). limit aceito como alias.
search string Busca sem distinção de maiúsculas em nome completo ou e-mail (máx. 256 chars).
is_active boolean Filtrar por status ativo.
role string Filtrar por papel: admin ou member.
curl "https://api.dailybot.com/v1/users/?is_active=true&search=alice&page_size=50" \
  -H "X-API-KEY: $DAILYBOT_API_KEY"

Resposta (200 OK):

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "uuid": "usr_abc123",
      "email": "[email protected]",
      "first_name": "Alice",
      "last_name": "Silva",
      "role": "member",
      "is_active": true,
      "timezone": "America/Sao_Paulo"
    }
  ]
}

PATCH /v1/users/{uuid}/

Atualiza o perfil ou metadados de um usuário. Apenas Administradores da Organização podem atualizar outros usuários.

Parâmetros do body

Nome Tipo Obrigatório Descrição
first_name string Não Nome do usuário.
last_name string Não Sobrenome do usuário.
timezone string Não Fuso horário IANA (ex. America/Sao_Paulo).
metadata object Não Metadados chave-valor personalizados do usuário.