Filtros e paginação

Com os endpoints de pesquisa você pode filtrar, classificar e paginar os resultados, segundo certos parâmetros.

Em cada endpoint você encontrará um detalhe dos parâmetros pelos quais classificar e filtrar. Se algum destes parâmetros estiver incorreto ou mal escrito, responderemos com um erro.

  • Para usar esta função, você terá que especificar seus filtros como parâmetros seguindo este padrão: filter[campo]=valor. Exemplo: filter[status]=CREATED.

  • Para filtrar um atributo com vários valores possíveis, você deve separar os valores com vírgulas. Por exemplo: filter[status]=CREATED,ACTIVE.

  • Quando filtrar, verá os resultados paginados e poderá escolher a quantidade de dados por página com page[size]=valor assim como especificar a página que quer ver por meio de page[number]=valor

Classificação

  • Você pode especificar a ordem dos resultados com certos parâmetros que deve enviar como uma lista de strings no filtro de tipo sort. Por exemplo:/cards/v1/?sort=status,card_type.

  • A ordem por default será ascendente. Para especificar uma ordem decrescente, você deve enviar o caractere "-" como um prefixo para o atributo. Por exemplo: /cards/v1/?sort=status,-card_type.