| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Retorna os registros de uma Database específica a partir do seu identificador único (idDatabase).
Este endpoint permite consultar os registros armazenados em uma Database, sendo possível controlar a quantidade de resultados retornados através dos parâmetros de paginação disponíveis na URL.
É recomendado para integrações que necessitam realizar consultas em massa, sincronização de dados, exportações ou processamento de registros armazenados na plataforma.
Parâmetros Utilizados
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
idDatabase | string | Sim | Identificador único da Database que será consultada. |
limit | integer | Sim | Quantidade máxima de registros retornados por requisição. |
offset | integer | Sim | Página da consulta. O valor inicial é 0. |
Exemplo de requisição
GET https://api.goalfy.com.br/api/databases/12345/filter?limit=100&offset=0Onde
| Parâmetro | Tipo |
|---|---|
idDatabase | 12345 |
limit | 100 |
offset | 0 |
Respostas esperadas
Sucesso 200Retorna uma lista paginada contendo os registros encontrados na Database informada.
A quantidade de registros retornados dependerá do valor informado no parâmetro limit.
Possíveis erros
400 Bad RequestRetornado quando algum parâmetro da URL possui valor inválido.
Exemplos:
limitmenor ou igual a zero.offsetcom formato inválido.- Parâmetros obrigatórios não informados.
404 Not FoundRetornado quando o Database informado não existe ou não foi localizado.
401 UnauthorizedRetornado quando o token de autenticação é inválido ou não foi enviado corretamente.
403 ForbiddenRetornado quando o usuário não possui permissão para acessar o Database informado.
Observações
ImportanteRecomenda-se utilizar paginação para consultas com grandes volumes de dados.
- O parâmetro limit controla a quantidade máxima de registros retornados por consulta.
- O parâmetro offset controla a página da consulta e inicia em 0.
- Databases com muitos registros podem gerar respostas extensas e consumir mais tempo de processamento.
- Dependendo das permissões do usuário autenticado, alguns registros podem não ser retornados.
- O retorno da requisição pode variar conforme as configurações da organização.
FAQ?
Perguntas frequentes que fazem.
Segue abaixo cards que podem te ajudar a tirar essas dúvidas: