GET
/
v1
/
ip
/
collections
/
{collectionId}
/
ipassets
/
{customerFacingId}
curl --request GET \
  --url https://staging.crossmint.com/api/v1/ip/collections/{collectionId}/ipassets/{customerFacingId} \
  --header 'X-API-KEY: <x-api-key>'
{
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "actionId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "nftMetadata": {
    "name": "Art #123",
    "description": "A unique story NFT",
    "image": "https://example.com/nft/123.png"
  },
  "ipAssetMetadata": {
    "title": "Harry Potter and the Philosopher's Stone",
    "createdAt": "1997-06-26T00:00:00",
    "ipType": "literature",
    "creators": [
      {
        "name": "JK Rowling",
        "email": "JKRowling@example.com",
        "crossmintUserLocator": "email:JKRowling@example.com:story",
        "description": "Author",
        "contributionPercent": 80,
        "socialMedia": [
          {
            "platform": "Wikipedia",
            "url": "https://en.wikipedia.org/wiki/J._K._Rowling"
          }
        ]
      },
      {
        "name": "Thomas Taylor",
        "address": "0x1234567890123456789012345678901234567890",
        "description": "Illustrator",
        "contributionPercent": 15
      },
      {
        "name": "Bloomsbury Publishing",
        "email": "BloomsburyPublishing@example.com",
        "address": "0x1234567890123456789012345678901234567890",
        "description": "Publisher",
        "contributionPercent": 5,
        "socialMedia": [
          {
            "platform": "Website",
            "url": "https://www.bloomsbury.com/"
          }
        ]
      }
    ],
    "media": [
      {
        "name": "ePub",
        "url": "link_to_epub",
        "mimeType": "application/epub+zip"
      },
      {
        "name": "Book Summary PDF",
        "url": "link_to_book_summary_pdf",
        "mimeType": "application/pdf"
      }
    ],
    "attributes": [
      {
        "key": "ISBN",
        "value": "978-0-7475-3269-0"
      },
      {
        "key": "Genre",
        "value": "Fantasy"
      }
    ]
  },
  "onChain": {
    "status": "success",
    "chain": "story-testnet",
    "contractAddress": "0x123",
    "ipAssetId": "0xAC6062FF53fa41e61Fe01B89B83d9dB96b5F9280",
    "tokenId": "1",
    "txId": "0x123",
    "explorerLink": "https://explorer.story.foundation/ipa/0xAC6062FF53fa41e61Fe01B89B83d9dB96b5F9280",
    "owner": "0x123"
  },
  "licenseTerms": [
    {
      "type": "non-commercial-social-remixing",
      "licenseTermsId": 1
    }
  ],
  "derivData": {
    "parentIpIds": [
      "0x123"
    ],
    "licenseTermsIds": [
      1
    ],
    "maxMintingFee": 0,
    "maxRevenueShare": 100,
    "maxRts": 10000000
  }
}
This API is still under development. Contact support for early access.

Headers

​
X-API-KEY
string
required

API key required for authentication

Path Parameters

​
collectionId
string
required
​
customerFacingId
string
required

Response

200 - application/json

IP Asset found

IPAsset response DTO