v1 GET

Listar e Filtrar Registos

GET /v1/records

Retorna uma lista paginada de registros na sua organização.

Parâmetros de consulta

Parâmetro Tipo Padrão Descrição
form_id string -- Filtrar por ID do formulário
project_id string -- Filtrar por ID do projeto
since ISO 8601 -- Apenas registros atualizados após este timestamp
page integer 1 Número da página
per_page integer 50 Itens por página (máx 500)
include_deleted boolean false Incluir registros excluídos

Exemplo: Listar todos os registros

curl -H "X-API-Key: mk_live_..." \
  "https://<ref>.supabase.co/functions/v1/api-gateway/v1/records"

Exemplo: Filtrar por formulário

curl -H "X-API-Key: mk_live_..." \
  "https://<ref>.supabase.co/functions/v1/api-gateway/v1/records?form_id=frm_abc123"

Exemplo: Sincronização delta (alterações desde)

Obtenha apenas os registros modificados desde sua última sincronização:

curl -H "X-API-Key: mk_live_..." \
  "https://<ref>.supabase.co/functions/v1/api-gateway/v1/records?since=2026-02-15T00:00:00Z"

Resposta

{
  "ok": true,
  "data": [
    {
      "id": "rec_abc123",
      "type": "record",
      "form_id": "frm_xyz",
      "project_id": "prj_456",
      "form_version_id": "fv_789",
      "properties": {
        "inspector_name": "Jane Smith",
        "condition": "good",
        "notes": "All systems operational"
      },
      "geometry": null,
      "created_by": "user_id",
      "updated_by": "user_id",
      "created_at": "2026-02-15T14:30:00Z",
      "updated_at": "2026-02-15T16:45:00Z",
      "status": "active",
      "assigned_to": null,
      "workflow_state_id": null,
      "priority": null
    }
  ],
  "pagination": {
    "total": 1250,
    "page": 1,
    "per_page": 50,
    "total_pages": 25
  }
}

Nota: O endpoint de lista omite a geometria por desempenho. Use GET /v1/records/:id para o registro completo com geometria, ou use consultas espaciais para consultar por localização.


GET /v1/records/:id

Retorna um único registro com geometria completa.

Exemplo

curl -H "X-API-Key: mk_live_..." \
  "https://<ref>.supabase.co/functions/v1/api-gateway/v1/records/rec_abc123"

Resposta

{
  "ok": true,
  "data": {
    "id": "rec_abc123",
    "type": "record",
    "form_id": "frm_xyz",
    "project_id": "prj_456",
    "properties": { "inspector_name": "Jane Smith" },
    "geometry": {
      "type": "Point",
      "coordinates": [-73.985, 40.758]
    },
    "created_at": "2026-02-15T14:30:00Z",
    "updated_at": "2026-02-15T16:45:00Z",
    "status": "active"
  }
}

Erro: Não encontrado

{
  "ok": false,
  "error": {
    "code": "not_found",
    "message": "Record rec_abc123 not found."
  }
}

Precisa de ajuda com a API? Entre em contato com nossa equipa de suporte.

Abrir a Aplicação Web