Skip to product menu
Skip to main content

Get a Portal

Description

You can use this API to fetch the details of a particular portal.

OAuth Scope:

SalesIQ.portals.READ

URL

Copiedhttps://{zohosalesiq_server_uri}/api/v2/portals/{screen name}

Example

Copiedhttps://salesiq.zoho.com/api/v2/portals/zylker-inc

Success Response

Copied{
  "url": "/api/v2/portals/zylker-inc",
  "object": "portal",
  "data": {
    "company_name": "zylker-inc",
    "website": "www.zylker-fashions.com",
    "owner": {
      "email_id": "patricia@zylker.com",
      "zuid": "54715436",
      "operator_id": "32308000000002001",
      "name": "Patricia"
    },
    "fax": "",
    "phone": "8344483886",
    "email_id": "tricia@zylker.com",
    "language": "en",
    "screenname": "zylker-inc",
    "address": "Texas",
    "description": "The worlds leading top brands for your display!",
    "logo": "/api/v2/zylker-inc/downloads/5add92f813f1667006ffc2b044978413?purpose=company_logo",
    "time_zone": "America/Los Angeles",
    "icon": "/images/zylker-inc/favicon.ico"
  }
}