---
title: "Retrieve upload portal information"
method: GET
path: "/api/organizations/{organizationId}/portals/{portalId}"
tags: ["OrganizationPortals"]
---

# Retrieve upload portal information

`GET /api/organizations/{organizationId}/portals/{portalId}`

## Request

- Base URL: `https://studio.edgeimpulse.com/v1`
- URL: `https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/portals/{portalId}`
- Auth: one of:
  - API key in header `x-api-key`
  - API key in cookie `jwt`
  - API key in header `x-jwt-token`
  - OAuth 2
    - Authorization code: `/v1/oauth/authorize`
    - Client credentials
    - Implicit: `/v1/oauth/authorize`
    - Password
    - Token URL: `/v1/oauth/token`
- TypeScript: <https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api/organizations/:organizationId/portals/:portalId/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve a single upload portals identified by ID.

## Path parameters

- `organizationId` integer, required
- `portalId` integer, required

## Response `200`

OK

- GetOrganizationPortalResponse
  - `success` boolean, required: Whether the operation succeeded
  - `error` string: Optional error description (set if 'success' was false)
  - `id` integer, required: Portal ID for the new upload portal
  - `name` string, required: The name of the upload portal.
  - `description` string: The purpose and description of the upload portal.
  - `url` string, required: The url postfix of the upload portal.
  - `token` string, required: The token used to validate access to the upload portal.
  - `bucketName` string, required: The S3 bucket name to store the uploaded data.
  - `bucketId` integer: S3 bucket ID. If missing, then this is using the Edge Impulse hosted bucket.
  - `bucketPath` string, required: The S3 bucket path where uploaded data is stored.
  - `bucketUrl` string: The full S3 bucket path where uploaded data is stored.
  - `storageProvider` string: The storage provider type (s3, azure, google, other).

---

[API](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api.md) - [All operations](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/llms.txt) - [OpenAPI document](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/revisions/e2a976d38427?raw)