List companies
curl --request GET \
--url https://api.zupy.com/api/v2/companies/ \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.zupy.com/api/v2/companies/"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.zupy.com/api/v2/companies/', 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.zupy.com/api/v2/companies/",
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.zupy.com/api/v2/companies/"
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))
}HttpResponse<String> response = Unirest.get("https://api.zupy.com/api/v2/companies/")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zupy.com/api/v2/companies/")
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{
"data": [
{
"id": "<string>",
"name": "<string>",
"trading_name": "<string>",
"slug": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"website": "<string>",
"logo_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"primary_color": "<string>",
"secondary_color": "<string>",
"social_links": "<unknown>",
"instagram_url": "<string>",
"google_review_url": "<string>",
"menu_url": "<string>",
"survey_url": "<string>",
"address": "<string>",
"city": "<string>",
"state": "<string>",
"zip_code": "<string>",
"country": "<string>",
"business_type": "<string>",
"description": "<string>",
"currency": "<string>",
"is_branch": true,
"branch_name": "<string>",
"is_public": true,
"is_active": true,
"loyalty_programs_count": 123,
"active_customers_count": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"zupy_balance": "<string>",
"program_setup_completed": true,
"airdrop_claimed_at": "2023-11-07T05:31:56Z"
}
],
"meta": {
"cursor": "<string>",
"has_next": true,
"count": 123
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Companies
List companies
List all companies accessible to the authenticated user.
GET
/
api
/
v2
/
companies
/
List companies
curl --request GET \
--url https://api.zupy.com/api/v2/companies/ \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.zupy.com/api/v2/companies/"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.zupy.com/api/v2/companies/', 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.zupy.com/api/v2/companies/",
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.zupy.com/api/v2/companies/"
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))
}HttpResponse<String> response = Unirest.get("https://api.zupy.com/api/v2/companies/")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zupy.com/api/v2/companies/")
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{
"data": [
{
"id": "<string>",
"name": "<string>",
"trading_name": "<string>",
"slug": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"website": "<string>",
"logo_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"primary_color": "<string>",
"secondary_color": "<string>",
"social_links": "<unknown>",
"instagram_url": "<string>",
"google_review_url": "<string>",
"menu_url": "<string>",
"survey_url": "<string>",
"address": "<string>",
"city": "<string>",
"state": "<string>",
"zip_code": "<string>",
"country": "<string>",
"business_type": "<string>",
"description": "<string>",
"currency": "<string>",
"is_branch": true,
"branch_name": "<string>",
"is_public": true,
"is_active": true,
"loyalty_programs_count": 123,
"active_customers_count": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"zupy_balance": "<string>",
"program_setup_completed": true,
"airdrop_claimed_at": "2023-11-07T05:31:56Z"
}
],
"meta": {
"cursor": "<string>",
"has_next": true,
"count": 123
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Authorizations
Per-company partner API key (zupy_pk_…). Validated by Zupy against the company integration key hash (Story 14.x); send it on every request as the X-API-Key header. Scoped read-write to the owning company's data.
Query Parameters
Pagination cursor value from previous response.
Number of results to return per page.
⌘I