---
title: "Get buckets"
method: GET
path: "/api/users/{userId}/buckets"
tags: ["User"]
---

# Get buckets

`GET /api/users/{userId}/buckets`

## Request

- Base URL: `https://studio.edgeimpulse.com/v1`
- URL: `https://studio.edgeimpulse.com/v1/api/users/{userId}/buckets`
- 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/users/:userId/buckets/get.ts> (a function with typed inputs; its response is checked against the schema)

List all organizational storage buckets that a user has access to. This function is only available through a JWT token.

## Path parameters

- `userId` integer, required

## Response `200`

OK

- ListOrganizationBucketsUserResponse
  - `success` boolean, required: Whether the operation succeeded
  - `error` string: Optional error description (set if 'success' was false)
  - `buckets` object[], required
    - `id` integer, required
    - `organizationId` integer, required
    - `organizationName` string, required
    - `bucket` string, required: S3 bucket
    - `region` string, required: S3 region
    - `whitelabelId` integer, required: The unique identifier of the white label this bucket belongs to, if any

---

[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)
