Brand

Get a brand by ID

get

Query parameters

idstringRequired

The UUID of the brand to retrieve

Header parameters

X-API-KEYstringRequired

Partner API Key

X-API-SECRETstringRequired

Partner API Secret

Responses

200

The brand has been successfully retrieved.

application/json

idstringRequired

Unique identifier

createdAtstring · date-timeRequired

Creation timestamp

updatedAtstring · date-timeRequired

Last update timestamp

namestringRequired

Brand name

languagestring · enumRequired

Language used to generate review responses

Possible values:

400

Invalid input format.

401

Unauthorized

404

Brand not found.

get/partners/brand

HTTPcURLJavaScriptPython

GET /partners/brand?id=text HTTP/1.1
Host: api.fullwhere.com
X-API-KEY: text
X-API-SECRET: text
Accept: */*

{
  "id": "text",
  "createdAt": "2026-08-09T03:58:37.042Z",
  "updatedAt": "2026-08-09T03:58:37.042Z",
  "name": "text",
  "logo": {
    "contentType": "text",
    "url": "text",
    "size": "text",
    "width": 1,
    "height": "text"
  },
  "language": "af",
  "supportEmails": [
    {
      "id": "text",
      "createdAt": "2026-08-09T03:58:37.042Z",
      "updatedAt": "2026-08-09T03:58:37.042Z",
      "email": "text",
      "domain": "text",
      "forwardingEmail": "text",
      "default": true,
      "enableInbound": true,
      "externalDnsConfig": {
        "dkim": {
          "host": "text",
          "type": "text",
          "value": "text"
        },
        "returnPath": {
          "host": "text",
          "type": "text",
          "value": "text"
        }
      },
      "dkimVerified": true,
      "returnPathVerified": true
    }
  ]
}

List brands

post

Header parameters

X-API-KEYstringRequired

Partner API Key

X-API-SECRETstringRequired

Partner API Secret

Body

application/json

limitnumber · min: 1 · max: 100Optional

Pagination limit

Default: 10

pagenumber · min: 1Optional

Page to retrieve

Default: 1

Responses

201

The brands have been successfully listed.

application/json

400

Invalid input format.

401

Unauthorized

post/partners/brand/list

HTTPcURLJavaScriptPython

POST /partners/brand/list HTTP/1.1
Host: api.fullwhere.com
X-API-KEY: text
X-API-SECRET: text
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "limit": 10,
  "page": 1
}

{
  "items": [
    {
      "id": "text",
      "createdAt": "2026-08-09T03:58:37.042Z",
      "updatedAt": "2026-08-09T03:58:37.042Z",
      "name": "text",
      "logo": {
        "contentType": "text",
        "url": "text",
        "size": "text",
        "width": 1,
        "height": "text"
      },
      "language": "af",
      "supportEmails": [
        {
          "id": "text",
          "createdAt": "2026-08-09T03:58:37.042Z",
          "updatedAt": "2026-08-09T03:58:37.042Z",
          "email": "text",
          "domain": "text",
          "forwardingEmail": "text",
          "default": true,
          "enableInbound": true,
          "externalDnsConfig": {
            "dkim": {
              "host": "text",
              "type": "text",
              "value": "text"
            },
            "returnPath": {
              "host": "text",
              "type": "text",
              "value": "text"
            }
          },
          "dkimVerified": true,
          "returnPathVerified": true
        }
      ]
    }
  ],
  "meta": {
    "itemCount": 1,
    "totalItems": 1,
    "itemsPerPage": 1,
    "totalPages": 1,
    "currentPage": 1
  }
}