---
title: "Get list of portals"
method: GET
path: "/v1/portals/"
---

# Get list of portals

`GET /v1/portals/`

## Request

- Base URL: `https://app.iconik.io/API/assets`
- URL: `https://app.iconik.io/API/assets/v1/portals/`
- Auth: none declared. Required headers: `App-ID`, `Auth-Token`
- TypeScript: <https://skmtc.dev/iconik/apis/iconik-assets/docs/v1/portals/get.ts> (a function with typed inputs; its response is checked against the schema)

Required roles:
 - can_read_portals

## Query parameters

- `per_page` integer
- `page` integer
- `scroll` boolean
- `scroll_id` string
- `sort` string
- `status` string
- `ids` string
- `query` string

## Headers

- `App-ID` string, required
- `Auth-Token` string, required

## Response `200`

Returns a list of portals

- PortalsSchema
  - `domain_total` integer
  - `first_url` string
  - `last_url` string
  - `next_url` string
  - `objects` PortalSchema[]
    - `config` PortalConfigSchema
      - `theme` Theme, required
        - `base` 'light' | 'dark', nullable
        - `colors` ThemeColors
          - `background` string, nullable
          - `primary` string, nullable
          - `secondary` string, nullable
          - `text` string, nullable
        - `typography` ThemeTypography
          - `font_family` string, nullable
          - `font_size_base` string, nullable
          - `heading_font_family` string, nullable
    - `created_by_user` string, uuid
    - `date_created` string, date-time
    - `date_modified` string, date-time
    - `description` string, nullable
    - `id` string, uuid
    - `keyframes` object[]
    - `logo` string
    - `logo_storage_id` string, uuid
    - `name` string, required
    - `playlist_id` string, uuid
    - `status` 'ACTIVE'
    - `system_domain_id` string, uuid
  - `page` integer
  - `pages` integer
  - `per_page` integer
  - `prev_url` string
  - `scroll_id` string
  - `search_after` unknown[]
    - unknown
  - `total` integer

## Other responses

- `400`: Bad request
- `401`: Token is invalid
- `404`: Requested page does not exist
- `default`: Error response

---

[API](https://skmtc.dev/iconik/apis/iconik-assets.md) - [All operations](https://skmtc.dev/iconik/apis/iconik-assets/llms.txt) - [OpenAPI document](https://skmtc.dev/iconik/apis/iconik-assets/revisions/62580d9e640e?raw)