---
title: "List organization projects"
method: GET
path: "/projects"
tags: ["Projects"]
---

# List organization projects

`GET /projects`

## Request

- Base URL: `https://viral.app/api/v1`
- URL: `https://viral.app/api/v1/projects`
- Auth: API key in header `x-api-key`

Retrieves a paginated list of projects for the organization with filtering and sorting options.

## Query parameters

- `page` number: Page number (1-based index)
- `perPage` number: Number of items per page (1-100)
- `sortCol` string: Sort column
- `sortDir` 'asc' | 'desc': Sort direction
- `search` string: Filter by project name

## Response `200`

OK

- object: Paginated list of organization projects with tracking data
  - `data` object[], required
    - `id` string, required
    - `name` string, required
    - `url` string, nullable, required
    - `description` string, nullable, required
    - `logo` string, nullable, required
    - `appleAppId` string, nullable, required
    - `visibleToCreators` boolean, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `actorType` 'user' | 'system' | 'api_token', required
    - `userId` string, required
    - `orgId` string, required
    - `trackedAccounts` number, nullable, required
    - `competitorStatus` 'internal' | 'competitor' | 'mixed' | 'none', nullable
    - `appleApp` object, nullable, required
      - `id` string, required
      - `title` string, required
      - `appleIdentifier` string, required
    - `createdByUser` object, nullable
      - `id` string, required
      - `name` string, required
      - `email` string, required
      - `emailVerified` boolean, required
      - `image` string, nullable, required
      - `createdAt` string, date-time, required
      - `updatedAt` string, date-time, required
      - `role` string, nullable, required
      - `banned` boolean, nullable, required
      - `banReason` string, nullable, required
      - `banExpires` string, date-time, nullable, required
      - `firstName` string, required
      - `lastName` string, required
      - `creatorContactProfileId` string, nullable, required
      - `creatorDiscoveryProfileId` string, nullable, required
      - `affiliateDashboardFirstOpenedAt` string, date-time, nullable, required
      - `isCreator` boolean, required
  - `pageCount` number, required: Total number of pages
  - `totalRows` number, required: Total number of rows

## Other responses

- `400`: 400
- `401`: 401
- `402`: 402
- `404`: 404
- `408`: 408
- `429`: 429
- `500`: 500

---

[API](https://skmtc.dev/viral/apis/viral-app-api.md) · [All operations](https://skmtc.dev/viral/apis/viral-app-api/llms.txt) · [OpenAPI document](https://skmtc.dev/viral/apis/viral-app-api/revisions/31e97fa79ef1?raw)
