List all portals in an account

GET

/api/v1/accounts/{account_id}/portals

Help Center

Get details of portals in an Account

Response Example

200 - Example 1

[
    {
        "id": 0,
        "archived": true,
        "color": "string",
        "config": {},
        "custom_domain": "string",
        "header_text": "string",
        "homepage_link": "string",
        "name": "string",
        "slug": "string",
        "page_title": "string",
        "account_id": 0,
        "categories": [
            {
                "id": 0,
                "description": "string",
                "locale": "string",
                "name": "string",
                "slug": "string",
                "position": 0,
                "portal_id": 0,
                "account_id": 0,
                "associated_category_id": 0,
                "parent_category_id": 0
            }
        ],
        "articles": [
            {
                "id": 0,
                "content": "string",
                "meta": {},
                "position": 0,
                "status": "draft",
                "title": "string",
                "slug": "string",
                "views": 0,
                "portal_id": 0,
                "account_id": 0,
                "author_id": 0,
                "category_id": 0,
                "folder_id": 0,
                "associated_article_id": 0
            }
        ]
    }
]

Request

Path Params

account_id

integer

required

The numeric ID of the account

Responses

🟢200OK

application/json; charset=utf-8

Success

Body

Array of all portals

array of:

integer

optional

archived

boolean

optional

color

string

optional

config

object

optional

Save information about locales, allowed_locales and default portal/help-center locale

custom_domain

string

optional

header_text

string

optional

The text content.

homepage_link

string

optional

name

string

optional

slug

string

optional

page_title

string

optional

account_id

integer

optional