Pular para o conteúdo principal
GET
/
v1
/
customers
Listar clientes
curl --request GET \
  --url https://api-payment.safefypay.com.br/v1/customers \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "items": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "externalId": "cliente_123",
        "name": "Joao Silva",
        "email": "joao@email.com",
        "document": "123.456.789-00",
        "documentType": "CPF",
        "phone": "5511999998888",
        "status": "Active",
        "metadata": null,
        "address": null,
        "createdAt": "2025-01-15T15:00:00Z"
      }
    ],
    "page": 1,
    "pageSize": 20,
    "totalItems": 1,
    "totalPages": 1,
    "hasNextPage": false,
    "hasPreviousPage": false
  },
  "message": null,
  "error": null
}

Documentation Index

Fetch the complete documentation index at: https://docs.safefypay.com.br/llms.txt

Use this file to discover all available pages before exploring further.

Retorna uma lista paginada de clientes com opções de filtragem.

Autorizações

Authorization
string
header
obrigatório

Token JWT obtido via /v1/auth/token

Parâmetros de consulta

page
integer
padrão:1

Numero da pagina

Exemplo:

1

pageSize
integer
padrão:20

Itens por pagina (max: 100)

Exemplo:

20

status
enum<string>

Filtrar por status

Opções disponíveis:
Active,
Inactive
Exemplo:

"Active"

documentType
enum<string>

Filtrar por tipo de documento

Opções disponíveis:
CPF,
CNPJ
Exemplo:

"CPF"

Buscar por nome, email ou documento

Exemplo:

"joao"

externalId
string

Filtrar por ID externo

Exemplo:

"cliente_123"

Resposta

Lista de clientes

data
object
message
string | null
error
object