Projects

List organization projects

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

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

Query parameters

pagenumber

Page number (1-based index)

Example:1
perPagenumber

Number of items per page (1-100)

Example:10
sortColstring

Sort column

Example:publishedAt
sortDir'asc' | 'desc'

Sort direction

Example:asc
searchstring

Filter by project name

Example:Fitness

Response

OK

pageCountnumber required

Total number of pages

totalRowsnumber required

Total number of rows

Example response

{
  "data": [
    {
      "id": "orgproj_FiT123NeS456",
      "name": "FitTracker Pro",
      "url": "https://fittracker.app",
      "description": "Premium fitness tracking app with social features and community challenges",
      "logo": "https://assets.viral.app/org_fit789/logo/file_fit123.png",
      "createdAt": "2025-09-23T08:15:30.254Z",
      "updatedAt": "2025-09-23T08:15:30.254Z",
      "appleAppId": "orgaplapp_FIT789xyz012",
      "visibleToCreators": true,
      "orgId": "org_abc123DEF456",
      "userId": "user_creator123",
      "trackedAccounts": 142,
      "appleApp": {
        "id": "orgaplapp_FIT789xyz012",
        "title": "FitTracker - Workout Planner",
        "appleIdentifier": "6474123456"
      }
    },
    {
      "id": "orgproj_MuS456iC789",
      "name": "MusicHub",
      "url": "https://musichub.fm",
      "description": "Social music discovery platform connecting artists and fans",
      "logo": "https://assets.viral.app/org_music123/logo/file_music456.png",
      "createdAt": "2025-09-22T14:30:15.123Z",
      "updatedAt": "2025-09-22T14:30:15.123Z",
      "appleAppId": null,
      "visibleToCreators": false,
      "orgId": "org_abc123DEF456",
      "userId": "user_creator456",
      "trackedAccounts": 75,
      "appleApp": null
    },
    {
      "id": "orgproj_FoO789dApp",
      "name": "TasteBlend",
      "url": "https://tasteblend.io",
      "description": null,
      "logo": null,
      "createdAt": "2025-09-21T09:45:22.789Z",
      "updatedAt": "2025-09-21T09:45:22.789Z",
      "appleAppId": null,
      "visibleToCreators": true,
      "orgId": "org_abc123DEF456",
      "userId": "user_creator789",
      "trackedAccounts": 0,
      "appleApp": null
    }
  ],
  "totalCount": 12,
  "page": 1,
  "perPage": 10,
  "totalPages": 2
}

Changes

No recorded changes to this operation across all 1 revision of this API.