Skip to main content
GET
/
v1
/
admin
/
partners
/
brands
List partner brands
curl --request GET \
  --url http://localhost:3000/v1/admin/partners/brands
{
  "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
}

Documentation Index

Fetch the complete documentation index at: https://docs.switchyard.run/llms.txt

Use this file to discover all available pages before exploring further.

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
​
search
string
​
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