Get Transferability

Get the transferable status of a collection.

This API is supported on EVM and Aptos chains.

You must contact sales to gain access to this API.

API scope required: collections.read

GET /v1-alpha1/minting/collections/{collectionId}/transferable

Get Transferability

cURL

curl --request GET \
  --url https://staging.crossmint.com/api/v1-alpha1/minting/collections/{collectionId}/transferable \
  --header 'X-API-KEY: <api-key>'

200

{
  "value": true
}

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 initial request. Example: your-custom-identifier

Response

200

application/json

Success

value · boolean

Example:

true