Listar clientes
curl --request GET \
--url https://api.ephra.io/v1/customers \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.ephra.io/v1/customers"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.ephra.io/v1/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ephra.io/v1/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.ephra.io/v1/customers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.ephra.io/v1/customers")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ephra.io/v1/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": [
{
"id": "cmtxc7d910004hlg1q8w2ker3",
"name": "Mariana Ribeiro Alves",
"email": "mariana.alves@exemplo.com.br",
"phone": "+5521998877665",
"document": "39053344705",
"documentType": "CPF",
"instagram": "@mariana.alves",
"birthDate": "1991-04-17T00:00:00.000Z",
"mailMarketing": true,
"taxFree": false,
"tags": [
"lancamento-setembro",
"cliente-recorrente"
],
"notes": "Pediu nota fiscal com o CNPJ da empresa dela a partir da próxima compra.",
"address": {
"street": "Rua Visconde de Pirajá",
"streetNumber": "414",
"complement": "sala 1108",
"neighborhood": "Ipanema",
"city": "Rio de Janeiro",
"state": "RJ",
"zipCode": "22410002"
},
"createdAt": "2026-08-14T11:20:33.000Z",
"updatedAt": "2026-09-09T16:41:02.000Z"
}
],
"pagination": {
"page": 1,
"pageSize": 10,
"total": 1,
"totalPages": 1
}
}{
"success": false,
"message": "Token inválido ou expirado"
}{
"success": false,
"message": "name: Nome é obrigatório"
}{
"success": false,
"message": "Muitas requisições. Tente novamente em breve."
}{
"success": false,
"message": "Erro interno do servidor"
}Vendas
Listar clientes
Lista os compradores da empresa autenticada, do cadastro mais recente para o mais antigo, com paginação e busca livre por nome, e-mail, telefone ou documento. Clientes excluídos não aparecem. Use para sincronizar a sua base de contatos com a da Ephra.
GET
/
v1
/
customers
Listar clientes
curl --request GET \
--url https://api.ephra.io/v1/customers \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.ephra.io/v1/customers"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.ephra.io/v1/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ephra.io/v1/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.ephra.io/v1/customers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.ephra.io/v1/customers")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ephra.io/v1/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": [
{
"id": "cmtxc7d910004hlg1q8w2ker3",
"name": "Mariana Ribeiro Alves",
"email": "mariana.alves@exemplo.com.br",
"phone": "+5521998877665",
"document": "39053344705",
"documentType": "CPF",
"instagram": "@mariana.alves",
"birthDate": "1991-04-17T00:00:00.000Z",
"mailMarketing": true,
"taxFree": false,
"tags": [
"lancamento-setembro",
"cliente-recorrente"
],
"notes": "Pediu nota fiscal com o CNPJ da empresa dela a partir da próxima compra.",
"address": {
"street": "Rua Visconde de Pirajá",
"streetNumber": "414",
"complement": "sala 1108",
"neighborhood": "Ipanema",
"city": "Rio de Janeiro",
"state": "RJ",
"zipCode": "22410002"
},
"createdAt": "2026-08-14T11:20:33.000Z",
"updatedAt": "2026-09-09T16:41:02.000Z"
}
],
"pagination": {
"page": 1,
"pageSize": 10,
"total": 1,
"totalPages": 1
}
}{
"success": false,
"message": "Token inválido ou expirado"
}{
"success": false,
"message": "name: Nome é obrigatório"
}{
"success": false,
"message": "Muitas requisições. Tente novamente em breve."
}{
"success": false,
"message": "Erro interno do servidor"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Página desejada, começando em 1.
Required range:
x >= 1Quantidade de itens por página (máximo 100).
Required range:
1 <= x <= 100Busca livre por nome, e-mail, telefone ou documento. O documento casa só pelos dígitos.
Minimum string length:
1⌘I
