---
title: "Get a list of Projects"
method: POST
path: "/projects/list"
tags: ["project"]
---

# Get a list of Projects

`POST /projects/list`

This operation gets a list of Projects, allowing for sorting and pagination. Note: Entities that have not been created successfully are not listed.

## Request body

- ProjectListMetadata — All api calls that return a list will have this metadata block as input
  - `filter` string — The filter in FIQL syntax used for the results.
  - `kind` string — The kind name
  - `sort_order` string — The sort order in which results are returned
  - `offset` integer — Offset from the start of the entity list
  - `length` integer — The number of records to retrieve relative to the offset
  - `sort_attribute` string — The attribute to perform sort on

## Response `200`

Success

- ProjectListIntentResponse — Response object for intentful operation of projects
  - `entities` ProjectIntentResource[]
    - `status` ProjectDefStatus — A Project resource.
      - `state` string — The state of the project entity.
      - `message_list` MessageResource[]
        - `message` string, required — If state is ERROR, a message describing the error.
        - `reason` string, required — If state is ERROR, a machine-readable snake-cased string.
        - `details` object — Custom key-value details relevant to the status.
      - `name` string, required — Project name.
      - `resources` object, required
        - `resource_domain` ResourceDomainResourcesStatus — The status for a resource domain (limits and values)
          - `resources` ResourceUtilizationStatus[], required — The utilization/limit for resource types
            - `units` string, required — The units of the resource type
            - `limit` integer — The resource consumption limit (unspecified is unlimited)
            - `resource_type` string, required — The type of resource (for example storage, CPUs)
            - `value` integer, required — The amount of resource consumed
        - `account_reference_list` AccountReference[] — List of accounts associated with the project.
          - `kind` string, required — The kind name
          - `name` string
          - `uuid` string, UUID, required
        - `environment_reference_list` EnvironmentReference[] — List of environments associated with the project.
          - `kind` string, required — The kind name
          - `name` string
          - `uuid` string, UUID, required
        - `default_subnet_reference` SubnetReference — The reference to a subnet
          - `kind` string, required — The kind name
          - `name` string
          - `uuid` string, UUID, required
        - `user_reference_list` UserReference[] — List of users added directly to the project.
          - `kind` string, required — The kind name
          - `name` string
          - `uuid` string, UUID, required
        - `is_default` boolean — Indicates if it is the default project. A default project is managed by the system and cannot be renamed or removed.
        - `external_user_group_reference_list` UserGroupReference[] — List of directory service groups reference. These groups are not managed by Nutanix.
          - `kind` string, required — The kind name
          - `name` string
          - `uuid` string, UUID, required
        - `subnet_reference_list` SubnetReference[] — List of subnets for the project.
          - `kind` string, required — The kind name
          - `name` string
          - `uuid` string, UUID, required
      - `description` string — Project description.
    - `spec` Project — A Project resource.
      - `name` string, required — Project name.
      - `resources` object, required
        - `resource_domain` ResourceDomainSpec — Resource domain specification (limits)
          - `resources` ResourceUtilizationSpec[] — The utilization limits for resource types
            - `limit` integer — The resource consumption limit
            - `resource_type` string, required — The type of resource (i.e. storage, CPUs)
        - `account_reference_list` AccountReference[] — List of accounts associated with the project.
          - `kind` string, required — The kind name
          - `name` string
          - `uuid` string, UUID, required
        - `environment_reference_list` EnvironmentReference[] — List of environments associated with the project.
          - `kind` string, required — The kind name
          - `name` string
          - `uuid` string, UUID, required
        - `subnet_reference_list` SubnetReference[] — List of subnets for the project.
          - `kind` string, required — The kind name
          - `name` string
          - `uuid` string, UUID, required
        - `external_user_group_reference_list` UserGroupReference[] — List of directory service user groups. These groups are not managed by Nutanix.
          - `kind` string, required — The kind name
          - `name` string
          - `uuid` string, UUID, required
        - `default_subnet_reference` SubnetReference — The reference to a subnet
          - `kind` string, required — The kind name
          - `name` string
          - `uuid` string, UUID, required
        - `user_reference_list` UserReference[] — List of users in the project.
          - `kind` string, required — The kind name
          - `name` string
          - `uuid` string, UUID, required
      - `description` string — Project description.
    - `api_version` string
    - `metadata` ProjectMetadata, required — The project kind metadata
      - `last_update_time` string, date-time — UTC date and time in RFC-3339 format when project was last updated
      - `kind` string, required — The kind name
      - `uuid` string, UUID — project uuid
      - `spec_version` integer — Version number of the latest spec.
      - `creation_time` string, date-time — UTC date and time in RFC-3339 format when project was created
      - `spec_hash` string — Hash of the spec. This will be returned from server.
      - `should_force_translate` boolean — Applied on Prism Central only. Indicate whether force to translate the spec of the fanout request to fit the target cluster API schema.
      - `owner_reference` UserReference — The reference to a user
        - `kind` string, required — The kind name
        - `name` string
        - `uuid` string, UUID, required
      - `categories` object — Categories for the project
      - `name` string — project name
  - `api_version` string, required
  - `metadata` ProjectListMetadataOutput, required — All api calls that return a list will have this metadata block
    - `filter` string — The filter used for the results
    - `kind` string — The kind name
    - `sort_order` string — The sort order in which results are returned
    - `offset` integer — Offset from the start of the entity list
    - `total_matches` integer — Total matches found
    - `length` integer — The number of records retrieved relative to the offset
    - `sort_attribute` string — The attribute to perform sort on

## Other responses

- `default` — Internal Error

---

[API](https://skmtc.net/nutanix/apis/nutanix-intentful-api.md) · [All operations](https://skmtc.net/nutanix/apis/nutanix-intentful-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nutanix/nutanix-intentful-api/revisions/40395083ab31/schema)