List merchants
curl --request GET \
--url https://app.equated.co/api/merchants \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.equated.co/api/merchants"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.equated.co/api/merchants', 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://app.equated.co/api/merchants",
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://app.equated.co/api/merchants"
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://app.equated.co/api/merchants")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.equated.co/api/merchants")
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{
"merchants": [
{
"id": 1,
"sourceType": "<string>",
"externalId": "<string>",
"name": "<string>",
"description": "<string>",
"website": "<string>",
"imageUrl": "<string>",
"logo": "<string>",
"isOverridden": {
"name": true,
"description": true
},
"isVendor": true,
"isCustomer": true,
"transactionCount": 123,
"totalSpent": 123,
"lastTransactionDate": "<string>",
"monthlySpend": [
{
"month": "<string>",
"amount": 123
}
]
}
]
}Merchants
List merchants
List the org’s merchants with lifetime spend/revenue totals and a 12-month monthly series. Filter by role (vendor/customer) and an optional date window; sort by amount or last activity. Merchants are auto-extracted from transaction names — see the Merchants concept doc.
GET
/
api
/
merchants
List merchants
curl --request GET \
--url https://app.equated.co/api/merchants \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.equated.co/api/merchants"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.equated.co/api/merchants', 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://app.equated.co/api/merchants",
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://app.equated.co/api/merchants"
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://app.equated.co/api/merchants")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.equated.co/api/merchants")
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{
"merchants": [
{
"id": 1,
"sourceType": "<string>",
"externalId": "<string>",
"name": "<string>",
"description": "<string>",
"website": "<string>",
"imageUrl": "<string>",
"logo": "<string>",
"isOverridden": {
"name": true,
"description": true
},
"isVendor": true,
"isCustomer": true,
"transactionCount": 123,
"totalSpent": 123,
"lastTransactionDate": "<string>",
"monthlySpend": [
{
"month": "<string>",
"amount": 123
}
]
}
]
}Authorizations
API token issued from the Equated app under Settings → API Tokens.
Query Parameters
Pattern:
^\d{4}-\d{2}-\d{2}$Pattern:
^\d{4}-\d{2}-\d{2}$Available options:
amount, date Available options:
asc, desc Available options:
vendor, customer, all Required range:
0 < x <= 200Required range:
x >= 0Response
200 - application/json
Merchants with aggregates
Show child attributes
Show child attributes