GET
/
2022-06-09
/
collections
/
{collectionId}
curl --request GET \
  --url https://staging.crossmint.com/api/2022-06-09/collections/{collectionId} \
  --header 'X-API-KEY: <api-key>'
{
  "id": "bb691876-edb3-404c-af3e-c019b8e2ed2c",
  "metadata": {
    "name": "Sample NFT Collection",
    "description": "This is a sample NFT collection",
    "imageUrl": "https://www.crossmint.com/assets/crossmint/logo.png",
    "symbol": "TOKEN"
  },
  "fungibility": "non-fungible",
  "onChain": {
    "chain": "polygon",
    "type": "erc-721",
    "contractAddress": "0x9564bD85f3D5677D86244dDb06F06bbD22D9d0DB"
  },
  "supplyLimit": 95,
  "payments": {
    "price": "0.001",
    "recipientAddress": "0x6C3b3225759Cbda68F96378A9F0277B4374f9F06"
  },
  "subscription": {
    "enabled": true
  }
}
For Solana collections the onChain.contractAddress property will be named onChain.mintAddress

Authorizations

​
X-API-KEY
string
header
required

Obtained in the Crossmint developer console

Path Parameters

​
collectionId
string
required

This is the identifier for the collection related to the request. Every project has default collections: default-solana and default-polygon.

The create-collection API will result in collections with UUID formatted collectionId. Example: 9c82ef99-617f-497d-9abb-fd355291681b

The create-collection-idempotent API allows you to specify an arbitrary identifier during the intitial request. Example: your-custom-identifer

Response

200
application/json
Success.
​
id
string
Example:

"bb691876-edb3-404c-af3e-c019b8e2ed2c"

​
metadata
object
​
fungibility
string
Example:

"non-fungible"

​
onChain
object
​
supplyLimit
integer
Example:

95

​
payments
object
​
subscription
object

Was this page helpful?