---
title: "Get projects"
method: GET
path: "/api/organizations/{organizationId}/projects"
tags: ["Organizations"]
---

# Get projects

`GET /api/organizations/{organizationId}/projects`

## Request

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

Retrieve all projects for the organization.

## Path parameters

- `organizationId` integer, required

## Response `200`

OK

- ListProjectsResponse
  - `success` boolean, required: Whether the operation succeeded
  - `error` string: Optional error description (set if 'success' was false)
  - `projects` Project[], required: Array with projects
    - `id` integer, required
    - `name` string, required
    - `description` string, required
    - `created` string, date-time, required
    - `owner` string, required: User or organization that owns the project
    - `lastAccessed` string, date-time
    - `lastModified` string, date-time
    - `lastModificationDetails` string: Details about the last modification
    - `logo` string: Custom logo for this project (not available for all projects)
    - `ownerUserId` integer
    - `ownerOrganizationId` integer
    - `ownerAvatar` string: URL of the project owner avatar, if any.
    - `ownerIsDeveloperProfile` boolean, required
    - `developerProfileUserId` integer: User ID of the developer profile, if any.
    - `collaborators` ProjectCollaborator[], required
      - `id` integer, required
      - `username` string, required
      - `name` string, required
      - `email` string, required
      - `photo` string
      - `created` string, date-time, required
      - `lastSeen` string, date-time
      - `staffInfo` StaffInfo, required
        - `isStaff` boolean, required
        - `hasSudoRights` boolean, required
        - `companyName` string
      - `pending` boolean, required
      - `jobTitle` string
      - `permissions` Permission[]: List of permissions the user has
      - `companyName` string
      - `activated` boolean, required: Whether the user has activated their account or not.
      - `mfaConfigured` boolean, required: Whether the user has configured multi-factor authentication
      - `stripeCustomerId` string: Stripe customer ID, if any.
      - `hasPendingPayments` boolean: Whether the user has pending payments.
      - `tier` 'free' | 'community-plus' | 'professional' | 'enterprise': The user account tier.
      - `idps` string[]: List of identity providers (e.g. Google, GitHub) that the user has used to sign in with
      - `isOwner` boolean, required
    - `labelingMethod` 'single_label' | 'object_detection' | 'label_map', required
    - `metadata` object, required: Metadata about the project
    - `dataExplorerScreenshot` string
    - `isEnterpriseProject` boolean, required: Whether this is an enterprise project
    - `whitelabelId` integer, nullable, required: Unique identifier of the white label this project belongs to, if any.
    - `whitelabelName` string: Name of the white label this project belongs to, if any.
    - `tags` string[]: List of project tags
    - `category` 'Accelerometer' | 'Audio' | 'Images' | 'Keyword spotting' | 'Object detection' | 'Other': Project category
    - `license` 'Apache-2.0' | 'BSD-3-Clause' | 'BSD-3-Clause-Clear'
    - `tier` 'free' | 'community-plus' | 'professional' | 'enterprise', required: The project tier. This is "enterprise" for all organization projects, or the user tier for all user projects.
    - `hasPublicVersion` boolean, required: Whether this project has been published or not.
    - `isPublic` boolean, required: Whether this is a public version of a project. A version is a snapshot of a project at a certain point in time, which can be used to periodically save the state of a project. Versions can be private (just for internal use and reference) or public, available to everyone. A public version can be cloned by anyone, restoring the state of the project at the time into a new, separate project.
    - `allowsLivePublicAccess` boolean, required: Whether this project allows live, public access. Unlike a public version, a live public project is not fixed in time, and always includes the latest project changes. Similar to public versions, a live public project can be cloned by anyone, creating a new, separate project.
    - `indPauseProcessingSamples` boolean, required
    - `publicProjectListed` boolean, required: If the project allows public access, whether to list it the public projects overview response. If not listed, the project is still accessible via direct link. If the project does not allow public access, this field has no effect.
    - `deletedDate` string, date-time
    - `fullDeletionDate` string, date-time
    - `scheduledFullDeletionDate` string, date-time

---

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