List customers
curl --request GET \
--url http://localhost:5000/api/v1/customers \
--header 'Authorization: Bearer <token>' \
--header 'x-api-key: <api-key>'import requests
url = "http://localhost:5000/api/v1/customers"
headers = {
"x-api-key": "<api-key>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-api-key': '<api-key>', Authorization: 'Bearer <token>'}
};
fetch('http://localhost:5000/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_PORT => "5000",
CURLOPT_URL => "http://localhost:5000/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: Bearer <token>",
"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 := "http://localhost:5000/api/v1/customers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
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("http://localhost:5000/api/v1/customers")
.header("x-api-key", "<api-key>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:5000/api/v1/customers")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"items": [
{
"id": "<string>",
"companyName": "<string>",
"registrationNumber": "<string>",
"countryOfIncorporation": {
"alpha2": "<string>",
"name": "<string>"
},
"addressLine1": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"stateProvinceRegion": "<string>",
"postalCode": "<string>",
"addressCountry": {
"alpha2": "<string>",
"name": "<string>"
},
"status": "DRAFT",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextCursor": "<string>",
"hasMore": true
}Customers
List customers
List all customers for the authenticated organization with cursor-based pagination.
GET
/
api
/
v1
/
customers
List customers
curl --request GET \
--url http://localhost:5000/api/v1/customers \
--header 'Authorization: Bearer <token>' \
--header 'x-api-key: <api-key>'import requests
url = "http://localhost:5000/api/v1/customers"
headers = {
"x-api-key": "<api-key>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-api-key': '<api-key>', Authorization: 'Bearer <token>'}
};
fetch('http://localhost:5000/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_PORT => "5000",
CURLOPT_URL => "http://localhost:5000/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: Bearer <token>",
"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 := "http://localhost:5000/api/v1/customers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
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("http://localhost:5000/api/v1/customers")
.header("x-api-key", "<api-key>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:5000/api/v1/customers")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"items": [
{
"id": "<string>",
"companyName": "<string>",
"registrationNumber": "<string>",
"countryOfIncorporation": {
"alpha2": "<string>",
"name": "<string>"
},
"addressLine1": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"stateProvinceRegion": "<string>",
"postalCode": "<string>",
"addressCountry": {
"alpha2": "<string>",
"name": "<string>"
},
"status": "DRAFT",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nextCursor": "<string>",
"hasMore": true
}Authorizations
Nuvera API application secret key
RS256 per-request signed JWT
Query Parameters
Available options:
DRAFT, PENDING_REVIEW, CORRECTION_REQUESTED, APPROVED, REJECTED, SUSPENDED Required range:
1 <= x <= 100