Get Portals

Fetches social portals accessible to the authenticated user. When the portal_id header is provided, returns only that specific portal. Without the portal_id header, returns all accessible portals.

Each portal includes brand counts, and subscription info.

Request URL

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

Scope

ZohoSocial.Organization.READCopied!

Request Parameters

- Request Headers

portal_idstringOptional

12345678Copied!

When provided, the response is scoped to this portal only. When omitted, all accessible portals are returned.

- Query Parameters

fieldsstring(length <= 1000)Optional

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

Maximum Length :1000Copied!

Response Parameters

- HTTP code 200

Response Body - application/json

JSON object

A list of portals accessible to the authenticated user.

Show Sub-Attributes

dataJSON array

List of portals the authenticated user has access to.

Show Sub-Attributes

idstring

Unique portal ID. To be used for all subsequent API calls to identify the portal context.

portal_namestring

Display name of the portal.

namestring

Unique portal slug or identifier.

is_defaultboolean

Whether this is the default portal for the authenticated user.

planstring

Name of the subscription plan.

allowed_brands_countinteger

Maximum number of brands allowed by the current subscription plan.

is_active_subscriptionboolean

Whether the portal has an active subscription. if set to false, the portal is in a grace period after subscription expiry and will be downgraded to free plan features. The portal will be suspended if the subscription is not renewed before the end of the grace period.

is_trial_accountboolean

Whether the portal is on a trial plan.

is_paid_planboolean

Whether the portal is on a paid plan.

configured_brands_countinteger

Number of brands currently configured in the portal.

Possible Response Codes

200HTTP code

Returns portal details accessible to the authenticated user.

Examples:

Get Portals (All): Response when no portal_id header is provided (returns all portals)
Get Portal (Single): Response when portal_id header is provided (single portal)

Endpoints

get /social/v2/socialportals

Copy full URL

Sample Request

Curl

Copied!

curl --request GET \
  --url 'https://{api_domain}/social/v2/socialportals?fields=id,portal_name,plan' \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
  --header 'portal_id: 12345678'

▼ Show full

Sample Response: HTTP 200

Get All Portals

Copied!

  {
    "data": [
      {
        "portal_name": "Zylker Corp",
        "allowed_brands_count": 20,
        "name": "zylkercorp",
        "is_active_subscription": true,
        "is_paid_plan": true,
        "configured_brands_count": 5,
        "id": "10001000",
        "is_default": true,
        "plan": "Agency_1",
        "is_trial_account": false
      },
      {
        "portal_name": "Zylker Marketing",
        "allowed_brands_count": 1,
        "name": "zylkermarketing",
        "is_active_subscription": true,
        "is_paid_plan": false,
        "configured_brands_count": 1,
        "id": "10002000",
        "is_default": false,
        "plan": "Standard-Trial_3",
        "is_trial_account": true
      }
    ]
  }

▼ Show full

Get Single Portal

Copied!

  {
    "data": [
      {
        "portal_name": "Zylker Corp",
        "allowed_brands_count": 20,
        "name": "zylkercorp",
        "is_active_subscription": true,
        "is_paid_plan": true,
        "configured_brands_count": 5,
        "id": "10001000",
        "is_default": false,
        "plan": "Agency_1",
        "is_trial_account": false
      }
    ]
  }

▼ Show full