Listar clientes

curl --request GET \
  --url https://besimplo.com/api/v1/customers \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://besimplo.com/api/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://besimplo.com/api/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: <api-key>"
  ],
]);

$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://besimplo.com/api/v1/customers"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://besimplo.com/api/v1/customers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "object": "list",
  "url": "/api/v1/customers",
  "has_more": false,
  "data": [
    {
      "id": "cus_01h455vb4pex5vsknk084sn02q",
      "object": "customer",
      "live_mode": true,
      "created": 1680893993,
      "name": "João Silva",
      "external_code": "01953808-3a3a-712f-99ce-f6943c8141db",
      "identifier": "123.456.789-00",
      "email": "joao.silva@exemplo.com",
      "phone": "+5511999998888",
      "description": "individual",
      "address": {
        "zip_code": "12345012",
        "street": "Alguma Rua",
        "number": "9934",
        "district": "D'algum Bairro",
        "city": "Campinas",
        "state": "SP",
        "complement": "Apt. 123"
      }
    }
  ]
}

GET

api

customers

Listar clientes

curl --request GET \
  --url https://besimplo.com/api/v1/customers \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://besimplo.com/api/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://besimplo.com/api/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: <api-key>"
  ],
]);

$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://besimplo.com/api/v1/customers"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://besimplo.com/api/v1/customers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "object": "list",
  "url": "/api/v1/customers",
  "has_more": false,
  "data": [
    {
      "id": "cus_01h455vb4pex5vsknk084sn02q",
      "object": "customer",
      "live_mode": true,
      "created": 1680893993,
      "name": "João Silva",
      "external_code": "01953808-3a3a-712f-99ce-f6943c8141db",
      "identifier": "123.456.789-00",
      "email": "joao.silva@exemplo.com",
      "phone": "+5511999998888",
      "description": "individual",
      "address": {
        "zip_code": "12345012",
        "street": "Alguma Rua",
        "number": "9934",
        "district": "D'algum Bairro",
        "city": "Campinas",
        "state": "SP",
        "complement": "Apt. 123"
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

A chave de API usada para autenticar a requisição e identificar a sua conta.

Exemplo: Authorization: ApiKey my-secure-key

Query Parameters

string<email>

Filtrar por e-mail do cliente

identifier

string

Filtrar por CPF ou CNPJ, com ou sem pontuação

Minimum string length: 1

Example:

"39053344705"

external_code

string

Filtrar pelo código externo definido pela integração

Required string length: 1 - 250

Example:

"crm_customer_123"

limit

integer

default:20

Resultados por página

Required range: 1 <= x <= 100

page

string

Cursor para próxima página

Response

Lista de clientes

object

enum<string>

required

Tipo do objeto. Sempre 'list'.

Available options:

list

Example:

"list"

url

string<uri-reference>

required

URL do recurso solicitado.

Example:

"/api/v1/customers"

has_more

boolean

required

Indica se há mais resultados disponíveis para paginação.

Example:

false

data

object[]

required

Lista de clientes.

Show child attributes

Visão geral

Endpoints

Listar clientes

Authorizations

Query Parameters

Response