Pular para o conteúdo
MyClinicAPI Docs

Paginação e filtros

Listas devolvem uma página por vez. Use o cursor para percorrer tudo e os filtros para trazer só o que interessa.

Parâmetros de paginação

Aceitos pelas operações de lista (confira cada uma na referência).

  • limitintegerOpcional
    consulta

    Itens por página (1–100). · Padrão: 25 · Entre 1 e 100

  • cursorstringOpcional
    consulta

    Cursor opaco recebido em meta.nextCursor. · Até 200 caracteres

  • pageintegerOpcional
    consulta

    Paginação numerada (tabelas): página 1-based, offset = (page − 1) × limit. Ignorado quando há cursor. Listas longas/feeds devem usar cursor. · Entre 1 e 200

Objeto meta

Toda lista responde com o conteúdo em data e o estado da paginação em meta.

  • hasNextbooleanObrigatório
  • nextCursorstring | nullObrigatório

    Passe em ?cursor= para a próxima página.

  • totalinteger | nullObrigatório

    Total de itens que atendem ao filtro (quando disponível).

  • limitintegerObrigatório

Paginação por cursor

  1. Peça a primeira página com limit (até 100).
  2. Se meta.hasNext for true, repita a chamada com cursor=meta.nextCursor e os mesmos filtros e ordenação.
  3. Pare quando hasNext for false. O cursor é opaco: não monte nem altere o valor.
curl -s "https://myclinc.leadpoint.com.br/v1/patients?limit=100&cursor=<nextCursor>" \  -H "Authorization: Bearer <TOKEN>"

Loops prontos em JavaScript e Python.

Ordenação, filtros e busca

Ordenação: ?sort=-campo,outro. Filtros múltiplos: valores separados por vírgula (?status=agendado,confirmado). Busca: ?q=.

Os campos aceitos em sort e os filtros de cada lista estão na página da operação, na seção Parâmetros de consulta.