Listar clientes

get

https://pay-public-api.raims.work/v1/client

Este endpoint permite listar os registros de todos os clientes.

Os filtros podem ser enviados tanto no formato de parâmetro na QUERY URL quanto no formato JSON no corpo da requisição.

Caso utilize os filtros na URL, tenha em mente que parâmetros passados sem valor serão interpretados como uma string vazia.

É possível utilizar apenas um ou todos os filtros disponíveis. Quanto maior a quantidade de filtros aplicados, menor será a quantidade de registros e maior será a precisão sobre o registro esperado.

Para utilizar os filtros da melhor forma, utilize apenas valores nos filtros que você tem certeza que foram gravados.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

limit

integer

required

1 to 100

Defaults to 100

Defina a quantidade de registros a ser exibida entre 1 e 100, podendo ser no formato de string (se passado na URL) ou inteiro se passado como objeto JSON no corpo da requisição.
Ex: "100" ou 100

show-deleted

string | null

Defaults to false

Filtro para mostrar registros excluidos.
Use uma string "true" passada como parametro na url ou um booleano true se passado como um objeto json.
Ex: "true" ou true

cpfCnpj

string | null

Filtrar por CPF ou CNPJ do cliente.
Ex: CPF: 12345678901 | CNPJ: 12345678000190

identifier

string

length between 32 and 32

Filtrar por Identificador único do cliente.
Ex: 0e01234567890b01ed0123456fghi1cf0

Observação: Caso tenha posse do Identificador único do cliente desejado, você poderá ver os dados deste cliente específico usando a sessão: Clientes -> Opção Exibir dados de um cliente específico

string | null

Filtrar por e-mail do cliente.
Ex: [email protected]

name

string | null

Filtrar nome completo ou parte do nome do cliente.
Ex 1: Jo
Ex 2: John
Ex 3: John Doe

Responses

200O resultado foi um sucesso e contém uma lista de clientes.

204O resultado foi um sucesso porém a lista está vazia.