Skip to main content
GET
/
v1
/
admin
/
partners
/
brands
List partner brands
curl --request GET \
  --url http://localhost:3000/v1/admin/partners/brands
import requests

url = "http://localhost:3000/v1/admin/partners/brands"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('http://localhost:3000/v1/admin/partners/brands', 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 => "3000",
CURLOPT_URL => "http://localhost:3000/v1/admin/partners/brands",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);

$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:3000/v1/admin/partners/brands"

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

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:3000/v1/admin/partners/brands")
.asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:3000/v1/admin/partners/brands")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
{
  "brands": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "company_name": "<string>",
      "contact_email": "jsmith@example.com",
      "contact_phone": "<string>",
      "business_type": "<string>",
      "company_logo_url": "<string>",
      "website_url": "<string>",
      "return_address_line1": "<string>",
      "return_address_line2": "<string>",
      "return_city": "<string>",
      "return_state": "<string>",
      "return_postal_code": "<string>",
      "return_country_code": "<string>",
      "approved_at": "2023-11-07T05:31:56Z",
      "rejection_reason": "<string>",
      "default_commission_rate_ambient": 123,
      "default_commission_rate_cold": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "brand": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "logo_url": "<string>"
      },
      "product_count": 123,
      "total_revenue": 123,
      "avg_weekly_units": 123
    }
  ],
  "total": 123
}
{
"error": "<string>",
"message": "<string>"
}

Query Parameters

limit
integer
default:20
Required range: 1 <= x <= 100
offset
integer | null
default:0
Required range: x >= 0
status
enum<string>
default:all
Available options:
all,
pending,
approved,
rejected,
suspended
sort_by
enum<string>
default:created_at
Available options:
created_at,
avg_weekly_units,
total_revenue
sort_dir
enum<string>
default:desc
Available options:
asc,
desc

Response

List of partner brands

brands
object[]
required
total
number
required