List Projects

You can list all projects available to your organization through the NeMo Entity Store microservice. This is useful when you need to search and filter projects to find the ones you need to manage or use.

Prerequisites

Before you can list projects, make sure that you have:

• Obtained the base URL of your NeMo Entity Store microservice.

• Permissions to access the NeMo Entity Store microservice endpoint.

---

How to List Projects

API

1. Make a GET request to the /v1/projects endpoint.

   cURL

   export ENTITY_STORE_BASE_URL=<URL for NeMo Entity Store>
   
   curl -X GET "${ENTITY_STORE_BASE_URL}/v1/projects" \
     -H 'Accept: application/json' \
     -H 'Content-Type: application/json' | jq
   

2. Review the listed projects by checking the response.

   Example Response

   {
     "object": "list",
     "data": [
       {
         "created_at": "2025-02-06T17:52:34.299499",
         "updated_at": "2025-02-06T17:52:34.299500",
         "name": "project-XYQj9Lg4nXLpSY6sNA2sbz",
         "description": "testing docs for qa",
         "namespace": "default",
         "custom_fields": {}
       },
       {
         "created_at": "2025-02-12T17:00:33.795767",
         "updated_at": "2025-02-12T17:00:33.795769",
         "name": "Documentation Test Project",
         "description": "A project for documentation testing",
         "namespace": "docs",
         "custom_fields": {
           "team": "documentation",
           "priority": "high",
           "status": "in-progress",
           "target_completion": "2024-03-31"
         },
         "ownership": {
           "created_by": "user@nvidia.com",
           "access_policies": {}
         }
       }
     ],
     "pagination": {
       "page": 1,
       "page_size": 10,
       "current_page_size": 6,
       "total_pages": 1,
       "total_results": 6
     },
     "sort": "created_at"
   }