Skip to main content
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.

Returns a paginated list of customers for the authenticated merchant.

Authorizations

​
Authorization
string
header
required

Token JWT obtido via /v1/auth/token

Query Parameters

​
page
integer
default:1

Numero da pagina

Example:

1

​
pageSize
integer
default:20

Itens por pagina (max: 100)

Example:

20

​
status
enum<string>

Filtrar por status

Available options:
Active,
Inactive
Example:

"Active"

​
documentType
enum<string>

Filtrar por tipo de documento

Available options:
CPF,
CNPJ
Example:

"CPF"

​
search
string

Buscar por nome, email ou documento

Example:

"joao"

​
externalId
string

Filtrar por ID externo

Example:

"cliente_123"

Response

Lista de clientes

​
data
object
​
message
string | null
​
error
object