---
title: "Retrieve a Project"
method: GET
path: "/v2/projects/{projectId}"
tags: ["Projects"]
---

# Retrieve a Project

`GET /v2/projects/{projectId}`

This endpoint allows you to retrieve a Project by providing the Project ID.

## Path parameters

- `projectId` integer, required

## Query parameters

- `page` number, nullable — Page number
- `limit` number, nullable — Items per page
- `sortBy` string
- `order` 'asc' | 'desc'

## Response `200`

Returns a Project with a paginated list of NFTs

- GetProjectResponse
  - `id` integer, required
  - `mintAddress` string, required — Base-58 encoded string representing an on-chain address
  - `semifungible` boolean — Whether or not the NFTs in this project are semifungible
  - `transferable` boolean — Whether or not the NFTs in this project can be transferred
  - `compressed` boolean — Whether or not the NFTs in this project are compressed
  - `core` boolean — Whether or not the NFTs in this project use mpl-core standard
  - `status` string, required
  - `sellerFeeBasisPoints` integer, required — Creator royalties in basis points - 100 basis points = 1%
  - `name` string, required — Name stored as on-chain metadata
  - `symbol` string — Symbol stored as on-chain metadata
  - `description` string — Description stored in the metadata
  - `image` string, required — Image for your NFT. When creating an NFT, this can be a base64 encoded string or a URL pointing to an image.
  - `animationUrl` string — URL pointing to the asset's animation.
  - `externalUrl` string — URL pointing to an external URL defining the asset
  - `attributes` object — Key-value pairs of your NFT attributes
  - `nfts` object, required
    - `results` object[], required
      - `name` string, required — Name stored as on-chain metadata
      - `symbol` string — Symbol stored as on-chain metadata
      - `description` string — Description stored in the metadata
      - `image` string, required — Image for your NFT. When creating an NFT, this can be a base64 encoded string or a URL pointing to an image.
      - `animationUrl` string — URL pointing to the asset's animation.
      - `externalUrl` string — URL pointing to an external URL defining the asset
      - `attributes` object — Key-value pairs of your NFT attributes
      - `id` number, required — Unique ID for an NFT in a Project
      - `projectId` number — The ID of the Project the NFT is part of
      - `transferable` boolean — Whether or not the NFT can be transferred based on the Project its a part of
      - `compressed` boolean — Whether or not the NFTs in the Project are compressed
      - `mintAddress` string, required — Base-58 encoded string representing an on-chain address
      - `ownerAddress` string — Wallet address for the NFT's owner
      - `claimerAddress` string — Wallet address allowed to claim the NFT
      - `status` string, required
    - `page` number, required — Page number
    - `limit` number, required — Number per page
    - `totalPages` number, required — Total number of pages
    - `totalResults` number, required — Total number of results

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found

---

[API](https://skmtc.net/underdogprotocol/apis/underdog-protocol-api.md) · [All operations](https://skmtc.net/underdogprotocol/apis/underdog-protocol-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/underdogprotocol/underdog-protocol-api/versions/714574b82cc5/schema)
