Skip to main content
GET
/
api
/
v1
/
brands
/
{brandId}
Get Brand
curl --request GET \
  --url https://api.example.com/api/v1/brands/{brandId} \
  --header 'Authorization: <authorization>'
import requests

url = "https://api.example.com/api/v1/brands/{brandId}"

headers = {"Authorization": "<authorization>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.example.com/api/v1/brands/{brandId}', 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.example.com/api/v1/brands/{brandId}",
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: <authorization>"
],
]);

$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.example.com/api/v1/brands/{brandId}"

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

req.Header.Add("Authorization", "<authorization>")

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.example.com/api/v1/brands/{brandId}")
.header("Authorization", "<authorization>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/brands/{brandId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body
{
  "success": true,
  "brand": {
    "id": "<string>",
    "name": "<string>",
    "domain": "<string>",
    "description": "<string>",
    "createdAt": "<string>",
    "stats": {
      "promptsCount": 123,
      "answersCount": 123,
      "competitorsCount": 123
    }
  }
}
Retrieve detailed information about a specific brand, including aggregate statistics for prompts, answers, and competitors.
Authorization
string
required
Bearer token. Example: Bearer qw-api-xxx

Path Parameters

brandId
string
required
The unique brand identifier

Response

success
boolean
Indicates if the request was successful
brand
object

Example Request

curl -X GET "https://www.qwairy.co/api/v1/brands/cm1234567890abcdef" \
  -H "Authorization: Bearer qw-api-your-token-here"

Example Response

{
  "success": true,
  "brand": {
    "id": "cm1234567890abcdef",
    "name": "My Brand",
    "domain": "mybrand.com",
    "description": "Leading provider of innovative solutions",
    "createdAt": "2024-01-15T10:30:00.000Z",
    "stats": {
      "promptsCount": 156,
      "answersCount": 312,
      "competitorsCount": 8
    }
  }
}

Error Responses

StatusCodeDescription
401INVALID_TOKENAuthentication failed
404BRAND_NOT_FOUNDBrand doesn’t exist or not accessible