{"openapi":"3.1.0","info":{"title":"Pódio Public API","version":"2026-08-23","description":"API REST multiempresa do Pódio Workspace. Use apenas no servidor e nunca exponha a chave no navegador."},"servers":[{"url":"https://workspace.podiomarketing.com.br/api/public/v1"}],"security":[{"bearerAuth":[]}],"paths":{"/me":{"get":{"summary":"Identidade da organização e da chave","security":[{"bearerAuth":[]}],"x-podio-scope":"marketplace.read","responses":{"200":{"description":"Sucesso"},"401":{"description":"Credencial inválida"},"403":{"description":"Escopo ou produto não autorizado"},"429":{"description":"Limite temporário atingido"}}}},"/crm/contacts":{"get":{"summary":"Lista contatos do CRM","security":[{"bearerAuth":[]}],"x-podio-scope":"crm.read","responses":{"200":{"description":"Sucesso"},"401":{"description":"Credencial inválida"},"403":{"description":"Escopo ou produto não autorizado"},"429":{"description":"Limite temporário atingido"}}},"post":{"summary":"Cria um contato no CRM","security":[{"bearerAuth":[]}],"x-podio-scope":"crm.write","responses":{"200":{"description":"Sucesso"},"401":{"description":"Credencial inválida"},"403":{"description":"Escopo ou produto não autorizado"},"429":{"description":"Limite temporário atingido"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}}}},"/crm/contacts/{id}":{"get":{"summary":"Consulta um contato","security":[{"bearerAuth":[]}],"x-podio-scope":"crm.read","responses":{"200":{"description":"Sucesso"},"401":{"description":"Credencial inválida"},"403":{"description":"Escopo ou produto não autorizado"},"429":{"description":"Limite temporário atingido"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Atualiza um contato","security":[{"bearerAuth":[]}],"x-podio-scope":"crm.write","responses":{"200":{"description":"Sucesso"},"401":{"description":"Credencial inválida"},"403":{"description":"Escopo ou produto não autorizado"},"429":{"description":"Limite temporário atingido"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"delete":{"summary":"Exclui um contato","security":[{"bearerAuth":[]}],"x-podio-scope":"crm.write","responses":{"200":{"description":"Sucesso"},"401":{"description":"Credencial inválida"},"403":{"description":"Escopo ou produto não autorizado"},"429":{"description":"Limite temporário atingido"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/crm/companies":{"get":{"summary":"Lista empresas","security":[{"bearerAuth":[]}],"x-podio-scope":"crm.read","responses":{"200":{"description":"Sucesso"},"401":{"description":"Credencial inválida"},"403":{"description":"Escopo ou produto não autorizado"},"429":{"description":"Limite temporário atingido"}}},"post":{"summary":"Cria uma empresa","security":[{"bearerAuth":[]}],"x-podio-scope":"crm.write","responses":{"200":{"description":"Sucesso"},"401":{"description":"Credencial inválida"},"403":{"description":"Escopo ou produto não autorizado"},"429":{"description":"Limite temporário atingido"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}}}},"/crm/deals":{"get":{"summary":"Lista negócios","security":[{"bearerAuth":[]}],"x-podio-scope":"crm.read","responses":{"200":{"description":"Sucesso"},"401":{"description":"Credencial inválida"},"403":{"description":"Escopo ou produto não autorizado"},"429":{"description":"Limite temporário atingido"}}},"post":{"summary":"Cria um negócio","security":[{"bearerAuth":[]}],"x-podio-scope":"crm.write","responses":{"200":{"description":"Sucesso"},"401":{"description":"Credencial inválida"},"403":{"description":"Escopo ou produto não autorizado"},"429":{"description":"Limite temporário atingido"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}}}},"/crm/activities":{"get":{"summary":"Lista atividades","security":[{"bearerAuth":[]}],"x-podio-scope":"crm.read","responses":{"200":{"description":"Sucesso"},"401":{"description":"Credencial inválida"},"403":{"description":"Escopo ou produto não autorizado"},"429":{"description":"Limite temporário atingido"}}},"post":{"summary":"Registra uma atividade","security":[{"bearerAuth":[]}],"x-podio-scope":"crm.write","responses":{"200":{"description":"Sucesso"},"401":{"description":"Credencial inválida"},"403":{"description":"Escopo ou produto não autorizado"},"429":{"description":"Limite temporário atingido"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}}}},"/crm/tasks":{"get":{"summary":"Lista tarefas","security":[{"bearerAuth":[]}],"x-podio-scope":"crm.read","responses":{"200":{"description":"Sucesso"},"401":{"description":"Credencial inválida"},"403":{"description":"Escopo ou produto não autorizado"},"429":{"description":"Limite temporário atingido"}}},"post":{"summary":"Cria uma tarefa","security":[{"bearerAuth":[]}],"x-podio-scope":"crm.write","responses":{"200":{"description":"Sucesso"},"401":{"description":"Credencial inválida"},"403":{"description":"Escopo ou produto não autorizado"},"429":{"description":"Limite temporário atingido"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}}}},"/leads":{"get":{"summary":"Lista leads","security":[{"bearerAuth":[]}],"x-podio-scope":"leads.read","responses":{"200":{"description":"Sucesso"},"401":{"description":"Credencial inválida"},"403":{"description":"Escopo ou produto não autorizado"},"429":{"description":"Limite temporário atingido"}}},"post":{"summary":"Cria um lead","security":[{"bearerAuth":[]}],"x-podio-scope":"leads.write","responses":{"200":{"description":"Sucesso"},"401":{"description":"Credencial inválida"},"403":{"description":"Escopo ou produto não autorizado"},"429":{"description":"Limite temporário atingido"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}}}},"/leads/{id}":{"get":{"summary":"Consulta um lead","security":[{"bearerAuth":[]}],"x-podio-scope":"leads.read","responses":{"200":{"description":"Sucesso"},"401":{"description":"Credencial inválida"},"403":{"description":"Escopo ou produto não autorizado"},"429":{"description":"Limite temporário atingido"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Atualiza um lead","security":[{"bearerAuth":[]}],"x-podio-scope":"leads.write","responses":{"200":{"description":"Sucesso"},"401":{"description":"Credencial inválida"},"403":{"description":"Escopo ou produto não autorizado"},"429":{"description":"Limite temporário atingido"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"delete":{"summary":"Exclui um lead","security":[{"bearerAuth":[]}],"x-podio-scope":"leads.write","responses":{"200":{"description":"Sucesso"},"401":{"description":"Credencial inválida"},"403":{"description":"Escopo ou produto não autorizado"},"429":{"description":"Limite temporário atingido"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/pages":{"get":{"summary":"Lista páginas e conversões","security":[{"bearerAuth":[]}],"x-podio-scope":"pages.read","responses":{"200":{"description":"Sucesso"},"401":{"description":"Credencial inválida"},"403":{"description":"Escopo ou produto não autorizado"},"429":{"description":"Limite temporário atingido"}}}},"/pages/submissions":{"get":{"summary":"Lista formulários recebidos","security":[{"bearerAuth":[]}],"x-podio-scope":"pages.read","responses":{"200":{"description":"Sucesso"},"401":{"description":"Credencial inválida"},"403":{"description":"Escopo ou produto não autorizado"},"429":{"description":"Limite temporário atingido"}}}},"/talks/conversations":{"get":{"summary":"Lista conversas","security":[{"bearerAuth":[]}],"x-podio-scope":"talks.read","responses":{"200":{"description":"Sucesso"},"401":{"description":"Credencial inválida"},"403":{"description":"Escopo ou produto não autorizado"},"429":{"description":"Limite temporário atingido"}}}},"/talks/conversations/{id}/messages":{"get":{"summary":"Lista mensagens sem payloads internos do provedor","security":[{"bearerAuth":[]}],"x-podio-scope":"talks.read","responses":{"200":{"description":"Sucesso"},"401":{"description":"Credencial inválida"},"403":{"description":"Escopo ou produto não autorizado"},"429":{"description":"Limite temporário atingido"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/mail/campaigns":{"get":{"summary":"Lista campanhas e métricas","security":[{"bearerAuth":[]}],"x-podio-scope":"mail.read","responses":{"200":{"description":"Sucesso"},"401":{"description":"Credencial inválida"},"403":{"description":"Escopo ou produto não autorizado"},"429":{"description":"Limite temporário atingido"}}}},"/usage":{"get":{"summary":"Consulta consumo e Créditos Pódio","security":[{"bearerAuth":[]}],"x-podio-scope":"usage.read","responses":{"200":{"description":"Sucesso"},"401":{"description":"Credencial inválida"},"403":{"description":"Escopo ou produto não autorizado"},"429":{"description":"Limite temporário atingido"}}}},"/marketplace/apps":{"get":{"summary":"Lista integrações disponíveis","security":[{"bearerAuth":[]}],"x-podio-scope":"marketplace.read","responses":{"200":{"description":"Sucesso"},"401":{"description":"Credencial inválida"},"403":{"description":"Escopo ou produto não autorizado"},"429":{"description":"Limite temporário atingido"}}}},"/webhooks":{"get":{"summary":"Lista webhooks","security":[{"bearerAuth":[]}],"x-podio-scope":"webhooks.manage","responses":{"200":{"description":"Sucesso"},"401":{"description":"Credencial inválida"},"403":{"description":"Escopo ou produto não autorizado"},"429":{"description":"Limite temporário atingido"}}},"post":{"summary":"Cria um webhook","security":[{"bearerAuth":[]}],"x-podio-scope":"webhooks.manage","responses":{"200":{"description":"Sucesso"},"401":{"description":"Credencial inválida"},"403":{"description":"Escopo ou produto não autorizado"},"429":{"description":"Limite temporário atingido"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}}}},"/webhooks/{id}":{"patch":{"summary":"Pausa ou ativa um webhook","security":[{"bearerAuth":[]}],"x-podio-scope":"webhooks.manage","responses":{"200":{"description":"Sucesso"},"401":{"description":"Credencial inválida"},"403":{"description":"Escopo ou produto não autorizado"},"429":{"description":"Limite temporário atingido"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"delete":{"summary":"Exclui um webhook","security":[{"bearerAuth":[]}],"x-podio-scope":"webhooks.manage","responses":{"200":{"description":"Sucesso"},"401":{"description":"Credencial inválida"},"403":{"description":"Escopo ou produto não autorizado"},"429":{"description":"Limite temporário atingido"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"PODIO_API_KEY"}},"parameters":{"page":{"name":"page","in":"query","schema":{"type":"integer","minimum":1}},"per_page":{"name":"per_page","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}}}},"meta":{"request_id":"33b8dd6f-2417-4e37-b8d8-afba6e046222","api_version":"2026-08-23"}}