Skip to main content
GET
/
api
/
v1
/
clients
Listar clientes
curl --request GET \
  --url https://upay-sistema-api.onrender.com/api/v1/clients \
  --header 'API-Key: <api-key>'
{
  "message": "<string>",
  "clients": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "email": "[email protected]",
      "document": "<string>",
      "phone": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "total": 123,
    "page": 123,
    "limit": 123,
    "orderBy": "<string>",
    "orderDirection": "<string>"
  }
}

Authorizations

​
API-Key
string
header
required

Chave de API obtida através do endpoint /api/credentials. Também aceita formato Bearer Token: Authorization: Bearer <api_key>

Query Parameters

​
page
integer
default:1

Número da página

Required range: x >= 1
​
limit
integer
default:20

Número de itens por página

Required range: 1 <= x <= 100
​
orderBy
enum<string>
default:createdAt

Campo para ordenação

Available options:
createdAt,
updatedAt,
name,
email
​
orderDirection
enum<string>
default:desc

Direção da ordenação

Available options:
asc,
desc
​
name
string

Filtrar por nome (busca parcial)

​
email
string

Filtrar por email (busca parcial)

Response

Lista de clientes

​
message
string
​
clients
object[]
​
pagination
object