Skip to content
ver .md original

Organização

Consulte a organização à qual a credencial atual pertence. Cada chamada da API é limitada a essa organização; use este endpoint para confirmar o contexto do org antes de rodar operações em lote.

GET/v1/organization/Chave de APICLI Auth

Organização atual

Recupera a organização à qual a credencial atual (chave de API ou token Bearer do CLI) pertence. Use para confirmar o escopo, inspecionar detalhes do plano e verificar a conectividade antes de executar tarefas em lote ou trocar de ambiente.

Resposta

{
  "uuid": "ba2371a9-81c7-4132-b9c4-a338561ec3a0",
  "name": "Acme Corp",
  "slug": "acme-corp",
  "plan": "growth",
  "chat_platform": "slack",
  "timezone": "America/New_York",
  "language": "en",
  "daily_reports_enabled": true,
  "kudos_enabled": true,
  "mood_enabled": false,
  "created_at": "2021-06-15T08:30:00Z"
}

Erros

StatusQuando
401Credencial ausente, inválida ou expirada.
403A organização da chave de API está em um plano gratuito.
403O plano da organização não inclui acesso à API.
429Throttled — cabeçalho Retry-After definido.
curl -sS -X GET 'https://api.dailybot.com/v1/organization/' \
  -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.

  • Cada chamada de API é limitada a uma única organização — aquela à qual a credencial pertence. Não é possível consultar múltiplas organizações em uma única chamada.

Organização

Cada chamada da API do Dailybot é limitada a uma única organização — a da credencial atual (X-API-KEY ou token Bearer da CLI). Use este endpoint para confirmar o escopo, inspecionar detalhes do plano e verificar a conectividade antes de rodar jobs em lote ou alternar entre ambientes.

GET /v1/organization/

Retorna o objeto de organização para a credencial atual.

Auth: Chave de API (X-API-KEY) ou token Bearer da CLI.

Campos de resposta

Campo Tipo Descrição
uuid string UUID da organização.
name string Nome de exibição da organização.
slug string Identificador seguro para URL.
plan string Nome do plano atual (ex.: growth, enterprise).
chat_platform string Plataforma de chat conectada (slack, teams, discord, google_chat).
timezone string Fuso horário padrão da organização (formato IANA).
language string Código de idioma padrão (en, es, pt).
daily_reports_enabled boolean Se os relatórios diários estão ativos.
kudos_enabled boolean Se o recurso de kudos está habilitado.
mood_enabled boolean Se o rastreamento de humor está habilitado.
created_at string (ISO 8601) Quando a organização foi criada.
curl -sS "https://api.dailybot.com/v1/organization/" \
  -H "X-API-KEY: $DAILYBOT_API_KEY"

Resposta (200 OK):

{
  "uuid": "ba2371a9-81c7-4132-b9c4-a338561ec3a0",
  "name": "Acme Corp",
  "slug": "acme-corp",
  "plan": "growth",
  "chat_platform": "slack",
  "timezone": "America/New_York",
  "language": "en",
  "daily_reports_enabled": true,
  "kudos_enabled": true,
  "mood_enabled": false,
  "created_at": "2021-06-15T08:30:00Z"
}

Códigos de erro

HTTP code Quando
401 invalid_credentials Credencial ausente, inválida ou expirada.
403 plan_free_api_keys_forbidden A organização da chave de API está em um plano gratuito.
403 plan_missing_core_api_integrations O plano da organização não inclui acesso à API.
429 Throttled — respeitar o cabeçalho Retry-After.

Veja a referência interativa completa em /pt/developers/api/organization.