---
title: "Fetch a portal"
method: GET
path: "/portal/{portalId}/fetch"
tags: ["Portal"]
---

# Fetch a portal

`GET /portal/{portalId}/fetch`

## Request

- Base URL: `https://api.chatbotkit.com/api/v1`
- URL: `https://api.chatbotkit.com/api/v1/portal/{portalId}/fetch`
- Auth: HTTP bearer

## Path parameters

- `portalId` string, required: The ID of the portal to retrieve

## Response `200`

The portal was retrieved successfully

- object: Blueprint properties
  - `alias` string, nullable: The unique alias for the instance
  - `name` string: The associated name
  - `description` string: The associated description
  - `meta` Meta: Meta data information
  - `id` string, required: The instance ID
  - `createdAt` number, required: The timestamp (ms) when the instance was created
  - `updatedAt` number, required: The timestamp (ms) when the instance was updated
  - `blueprintId` string, nullable: The ID of the blueprint
  - `slug` string: The slug of the portal
  - `config` object: The config of the portal

## Other responses

- `default`: An error response

---

[API](https://skmtc.dev/chatbotkit/apis/cbk-api.md) · [All operations](https://skmtc.dev/chatbotkit/apis/cbk-api/llms.txt) · [OpenAPI document](https://skmtc.dev/chatbotkit/apis/cbk-api/revisions/13d250576136?raw)