Listar todos os clientes - RivooPay

Get all clients of a company

curl --request GET \
  --url https://api.rivoopay.com/client \
  --header 'X-API-KEY: <api-key>'

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

fetch('https://api.rivoopay.com/client', 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.rivoopay.com/client",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <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://api.rivoopay.com/client"

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

	req.Header.Add("X-API-KEY", "<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://api.rivoopay.com/client")

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

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

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

[
  {
    "id": "clnt_clx1234567890abcdef",
    "taxId": "053.054.053-64",
    "name": "Cliente Bola",
    "email": "bola@email.com",
    "phone": "41999999999",
    "status": "ACTIVE",
    "companyId": "comp_clx9876543210fedcba",
    "createdAt": "2025-02-03T10:00:00Z",
    "updatedAt": "2025-02-03T10:00:00Z",
    "postalCode": "80215100",
    "address": "Rua Engenheiros Rebouças",
    "district": "Rebouças",
    "number": "2000",
    "line1": "Green apartment"
  }
]

GET

/

client

Get all clients of a company

curl --request GET \
  --url https://api.rivoopay.com/client \
  --header 'X-API-KEY: <api-key>'

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

fetch('https://api.rivoopay.com/client', 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.rivoopay.com/client",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <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://api.rivoopay.com/client"

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

	req.Header.Add("X-API-KEY", "<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://api.rivoopay.com/client")

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

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

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

[
  {
    "id": "clnt_clx1234567890abcdef",
    "taxId": "053.054.053-64",
    "name": "Cliente Bola",
    "email": "bola@email.com",
    "phone": "41999999999",
    "status": "ACTIVE",
    "companyId": "comp_clx9876543210fedcba",
    "createdAt": "2025-02-03T10:00:00Z",
    "updatedAt": "2025-02-03T10:00:00Z",
    "postalCode": "80215100",
    "address": "Rua Engenheiros Rebouças",
    "district": "Rebouças",
    "number": "2000",
    "line1": "Green apartment"
  }
]

Authorizations

X-API-KEY

string

header

required

Response

List of clients retrieved successfully

id

string

required

Client unique identifier (format: clnt_{cuid2})

Example:

"clnt_clx1234567890abcdef"

taxId

string

required

Client tax ID (CPF/CNPJ) - formatted

Pattern: ^[0-9]{11,14}$

Example:

"053.054.053-64"

name

string

required

Client full name

Maximum string length: 255

Example:

"Cliente Bola"

email

string<email>

required

Client email address

Example:

"bola@email.com"

phone

string

required

Client phone number (Brazilian format)

Pattern: ^[0-9]{10,11}$

Example:

"41999999999"

status

enum<string>

default:ACTIVE

required

Client status

Available options:

ACTIVE,

INACTIVE

Example:

"ACTIVE"

companyId

string

required

Company ID that owns this client (format: comp_{cuid2})

Example:

"comp_clx9876543210fedcba"

createdAt

string<date-time>

required

Client creation timestamp

Example:

"2025-02-03T10:00:00Z"

updatedAt

string<date-time>

required

Client last update timestamp

Example:

"2025-02-03T10:00:00Z"

postalCode

object | null

Client postal code (CEP)

Example:

"80215100"

address

object | null

Client street address

Example:

"Rua Engenheiros Rebouças"

district

object | null

District/neighborhood

Example:

"Rebouças"

number

object | null

Street number

Example:

"2000"

line1

object | null

Address complement (line 1)

Example:

"Green apartment"