# Referência da API > Todos os endpoints da API v1 do ByDomu com parâmetros, a permissão que pedem, a resposta e exemplos em cURL, JavaScript e Python. A API v1 do ByDomu é REST com JSON. Esta referência é gerada a partir da spec OpenAPI, que por sua vez sai do código das rotas: cada endpoint traz seus parâmetros, a permissão que pede e exemplos. Não há SDK oficial; com a spec você pode gerar seu cliente. Endereço base `https://api.bydomu.com/v1` OpenAPI [openapi.json · v3.1.0](https://api.bydomu.com/v1/openapi.json) Coleções [Postman](https://developers.bydomu.com/bydomu-api.postman_collection.json) · [Bruno](https://developers.bydomu.com/bydomu-api.bruno_collection.json) Para agentes de IA [llms.txt](https://developers.bydomu.com/llms.txt) · [llms-full.txt](https://developers.bydomu.com/llms-full.txt) Esta referência é gerada a partir do código da API, por isso as descrições estão em espanhol. Nomes, parâmetros e exemplos são iguais em qualquer idioma. ## Autenticação A chave vai no cabeçalho `X-API-Key` (Authorization: Bearer não é aceito). Ela é criada no ByDomu, em Configurações › API Keys, e a completa aparece uma só vez. ```bash curl https://api.bydomu.com/v1/me \ -H "X-API-Key: $BYDOMU_API_KEY" ``` `domu_pk_live_` publicável Para sites e o navegador. Só: portal:read, leads:write, booking:write, finder:write, events:write. `domu_sk_live_` secreta Só de um servidor: com Origin (navegador) responde 403 SECRET_KEY_IN_BROWSER. Qualquer permissão. `domu_live_` legado Chaves criadas antes dos tipos. Continuam funcionando igual. ### Níveis de acesso Nível Planos Como se obtém 1 **Chaves publicáveis** 300 requisições e 60 escritas por minuto · até 5 chaves Qualquer plano pago Sem solicitação 2 **Secretas somente leitura** 60 requisições por minuto · até 2 chaves Business · Enterprise Automático 3 **Escritas, mensagens, webhooks e limites altos** Sob medida do aprovado Qualquer plano pago Revisão do suporte ## Paginação As listas recebem `page` (a partir de 1) e `pageSize`, e respondem com os dados e o total. Cada endpoint informa seu pageSize máximo. Contatos, negócios e tarefas aceitam também cursor. ```json { "data": [ … ], "meta": { "total": 64, "page": 1, "pageSize": 12, "totalPages": 6 } } ``` ## Erros Sempre com o mesmo formato. Dados que não passam na validação do esquema respondem 400 com a lista de problemas. ```json { "error": { "code": "FORBIDDEN", "message": "La API key no tiene el scope requerido: contacts:read" } } ``` **400** `VALIDATION_ERROR` Dados de entrada inválidos **401** `UNAUTHORIZED` Chave ausente ou inválida **402** `PAYMENT_REQUIRED` Conta somente leitura: escrita recusada **403** `FORBIDDEN` A chave não tem essa permissão **403** `SECRET_KEY_IN_BROWSER` Chave secreta usada em um navegador **403** `API_ACCESS_REQUIRED` O nível da conta não permite esta chave **403** `PLAN_LIMIT_REACHED` Um limite do plano foi atingido **404** `NOT_FOUND` Recurso não encontrado **409** `IDEMPOTENCY_CONFLICT` Idempotency-Key reutilizada com outro corpo **409** `IDEMPOTENCY_IN_PROGRESS` Outra requisição com a mesma Idempotency-Key ainda está em andamento **429** `RATE_LIMITED` Limite por minuto excedido **429** `TENANT_RATE_LIMITED` Limite de escritas por minuto da organização excedido ## Limites Uma chave publicável tem 300 requisições e 60 escritas por minuto; uma secreta, 60 e 30. O suporte pode aprovar mais. Cada resposta traz `X-RateLimit-Limit`, `X-RateLimit-Remaining` e `X-RateLimit-Reset`; ao passar, `429 RATE_LIMITED` com `Retry-After`. Em qualquer escrita você pode enviar `Idempotency-Key`: uma nova tentativa com a mesma chave e o mesmo corpo devolve a resposta original com `Idempotency-Status: replayed`. Vale por 24 horas. ## Recursos [**Conta** 1 endpoint](https://developers.bydomu.com/pt/referencia/get-me) [**Portal** 1 endpoint](https://developers.bydomu.com/pt/referencia/get-portal) [**Imóveis** 6 endpoints](https://developers.bydomu.com/pt/referencia/list-properties) [**Corretores** 2 endpoints](https://developers.bydomu.com/pt/referencia/list-agents) [**Leads** 2 endpoints](https://developers.bydomu.com/pt/referencia/submit-lead) [**Buscador** 1 endpoint](https://developers.bydomu.com/pt/referencia/submit-finder) [**Reservas** 4 endpoints](https://developers.bydomu.com/pt/referencia/list-booking-agents) [**Contatos** 4 endpoints](https://developers.bydomu.com/pt/referencia/list-contacts) [**Funis** 2 endpoints](https://developers.bydomu.com/pt/referencia/list-pipelines) [**Negócios** 5 endpoints](https://developers.bydomu.com/pt/referencia/list-deals) [**Tarefas** 4 endpoints](https://developers.bydomu.com/pt/referencia/list-tasks) [**Documentos** 2 endpoints](https://developers.bydomu.com/pt/referencia/list-documents) [**Envelopes de assinatura** 2 endpoints](https://developers.bydomu.com/pt/referencia/list-envelopes) [**Conversas** 4 endpoints](https://developers.bydomu.com/pt/referencia/list-conversations) [**Compromissos** 5 endpoints](https://developers.bydomu.com/pt/referencia/list-appointments) [**Equipe** 2 endpoints](https://developers.bydomu.com/pt/referencia/list-team-members) [**Etiquetas** 1 endpoint](https://developers.bydomu.com/pt/referencia/list-tags) [**Campos personalizados** 1 endpoint](https://developers.bydomu.com/pt/referencia/list-custom-fields) [**Comissões** 2 endpoints](https://developers.bydomu.com/pt/referencia/list-commissions) [**Contabilidade** 2 endpoints](https://developers.bydomu.com/pt/referencia/list-accounting-entries) [**Aluguéis** 2 endpoints](https://developers.bydomu.com/pt/referencia/list-leases) [**Notas** 1 endpoint](https://developers.bydomu.com/pt/referencia/create-note) [**Eventos** 4 endpoints](https://developers.bydomu.com/pt/referencia/list-event-types) [**Webhooks** 4 endpoints](https://developers.bydomu.com/pt/referencia/list-webhooks) [**Modo de prueba** 2 endpoints](https://developers.bydomu.com/pt/referencia/reset-test-data)