Get Brands

Fetches brands under the specified portal. When brand_id is provided, returns that specific brand. Without brand_id, returns all brands with pagination.

Request URL

https://{api_domain}/social/v2/socialbrands

Scope

ZohoSocial.Organization.READCopied!

Request Parameters

- Request Headers

portal_idstringMandatory

12345678Copied!

Unique identifier for your Zoho Social portal. Use Get Portals to retrieve your portal ID.

brand_idstringOptional

10001000000251005Copied!

When provided, returns only the specified brand. When omitted, returns all brands.

- Query Parameters

offsetintegerOptional

Pagination offset for retrieving brands. Ignored if brand_id is provided.

limitintegerOptional

Pagination limit for retrieving brands. Ignored if brand_id is provided.

fieldsstring(length <= 1000)Optional

Comma-separated list of fields to include in the response.
Example: fields=id,name,timezone

Maximum Length :1000Copied!

Response Parameters

- HTTP code 200

Response Body - application/json

JSON object

A list of brands under a portal.

Show Sub-Attributes

dataJSON array

List of brands under the portal.

Show Sub-Attributes

idstring

Unique brand ID.

namestring

Name of the brand.

descriptionstring

Description of the brand.

image_urluri

URL of the brand logo or image.

timezonestring

Timezone abbreviation of the brand.

locationstring

Location associated with the brand.

is_defaultboolean

Whether this is the default brand in the portal.

cursorinteger

Pagination cursor. Present only in multi-brand (All) responses.

Possible Response Codes

200HTTP code

Returns brand details under the current portal.

Examples:

Get Brands (All): Response when no brand_id is provided (returns all brands with cursor)
Get Brand (Single): Response when brand_id is provided (single brand, no cursor)

Endpoints

get /social/v2/socialbrands

Copy full URL

Sample Request

Curl

Copied!

curl --request GET \
  --url 'https://{api_domain}/social/v2/socialbrands?offset=0&limit=20&fields=id,name,timezone' \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
  --header 'brand_id: 10001000000251005'

▼ Show full

Sample Response: HTTP 200

Get All Brands

Copied!

  {
    "cursor": 3,
    "data": [
      {
        "timezone": "IST",
        "image_url": "https://example.com/brand1-logo.png",
        "name": "Zylker Brand",
        "description": "Official brand for Zylker Corp",
        "location": "Chennai, TN, India",
        "id": "10001000000019021",
        "is_default": true
      },
      {
        "timezone": "IST",
        "image_url": "https://example.com/brand2-logo.png",
        "name": "Zylker Asia",
        "description": "",
        "location": "Mumbai, MH, India",
        "id": "10001000000251005",
        "is_default": false
      },
      {
        "timezone": "BDT",
        "image_url": "https://example.com/brand3-logo.png",
        "name": "Zylker Tech",
        "description": "Tech division",
        "location": "Dhaka, Bangladesh",
        "id": "10001000003394192",
        "is_default": false
      }
    ]
  }

▼ Show full

Get Single Brand

Copied!

  {
    "data": [
      {
        "timezone": "IST",
        "image_url": "https://example.com/brand2-logo.png",
        "name": "Zylker Asia",
        "description": "",
        "location": "Mumbai, MH, India",
        "id": "10001000000251005",
        "is_default": false
      }
    ]
  }

▼ Show full