Skip to content
Highlight Docs

Get collection

GET
/collection/{highlightId}

Get a collection by its highlight ID.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
highlightId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Collection details

object
highlightId
required
string
collectionId
required
Any of:
string
name
required
string
description
required
Any of:
string
logoMediaId
required
string
baseUriId
required
Any of:
string
royaltyAddress
required
Any of:
string
royaltyAmount
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
tokenManager
required
Any of:
string
status
required
string
Allowed values: Draft InProgress Live Migrated Disabled
type
required
string
Allowed values: OpenEdition LimitedEdition OneOfOne Series GenerativeSeries
contract
required
object
id
required
string
chainId
required
integer
>= -9007199254740991 <= 9007199254740991
type
required
string
Allowed values: GenerativeSeries Series MultipleEditions MultipleEditionsDFS SingleEdition SingleEditionDFS EditionsDFS1155
standard
required
string
Allowed values: ERC721 ERC1155
creatorAddress
required
string
name
required
string
address
required
Any of:
string
symbol
required
string
contractUri
required
Any of:
string
status
required
string
Allowed values: Draft Deploying Live
createdAt
required
string
updatedAt
required
string
createdAt
required
string
updatedAt
required
string
archivedAt
required
Any of:
string
hidden
required
Any of:
boolean
disabled
required
Any of:
boolean
series
required
Any of:
object
size
required
integer
<= 9007199254740991
isCollectorsChoice
boolean
assetsMediaId
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
generative
required
Any of:
object
size
required
integer
<= 9007199254740991
codeMediaId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
isCurated
boolean
isGpuRendering
boolean
editionType
string
Allowed values: Limited Open
allowedHashes
Array<string>
requiredParams
Array<string>
captureSettings
object
trigger
required
string
Allowed values: Function Delay
delay
integer
> 0 <= 9007199254740991
selector
string
>= 1 characters
selectorType
string
Allowed values: SVG ELEMENT
viewPortHeight
integer
> 0 <= 9007199254740991
viewPortWidth
integer
> 0 <= 9007199254740991
edition
required
Any of:
object
size
required
integer
<= 9007199254740991
name
string
>= 1 characters
description
string
>= 1 characters
imageMediaId
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
animationMediaId
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
imageMedia
Any of:
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
accountId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
kind
required
string
Allowed values: File Directory
scope
required
string
Allowed values: Collection User
provenance
required
string
Allowed values: UserUpload SystemGenerated
status
required
string
Allowed values: Pending Processing Ready Failed
fileName
required
string
mimeType
required
Any of:
string
fileSize
required
Any of:
integer
<= 9007199254740991
contentHash
required
Any of:
string
parentId
required
Any of:
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
path
required
Any of:
string
uploadedAt
required
Any of:
string
locations
required
Array<object>
object
id
required
string
mediaId
required
string
provider
required
string
Allowed values: R2 Arweave S3 IPFS
role
required
string
Allowed values: Origin Archive Mirror
reference
required
string
status
required
string
Allowed values: Pending Succeeded Failed
attempts
required
integer
<= 9007199254740991
lastError
required
Any of:
string
syncedAt
required
Any of:
string
metadata
required
Any of:
object
key
additional properties
createdAt
required
string
updatedAt
required
string
url
required
Any of:
string format: uri
createdAt
required
string
updatedAt
required
string
animationMedia
Any of:
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
accountId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
kind
required
string
Allowed values: File Directory
scope
required
string
Allowed values: Collection User
provenance
required
string
Allowed values: UserUpload SystemGenerated
status
required
string
Allowed values: Pending Processing Ready Failed
fileName
required
string
mimeType
required
Any of:
string
fileSize
required
Any of:
integer
<= 9007199254740991
contentHash
required
Any of:
string
parentId
required
Any of:
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
path
required
Any of:
string
uploadedAt
required
Any of:
string
locations
required
Array<object>
object
id
required
string
mediaId
required
string
provider
required
string
Allowed values: R2 Arweave S3 IPFS
role
required
string
Allowed values: Origin Archive Mirror
reference
required
string
status
required
string
Allowed values: Pending Succeeded Failed
attempts
required
integer
<= 9007199254740991
lastError
required
Any of:
string
syncedAt
required
Any of:
string
metadata
required
Any of:
object
key
additional properties
createdAt
required
string
updatedAt
required
string
url
required
Any of:
string format: uri
createdAt
required
string
updatedAt
required
string
attributes
Array<object>
object
traitType
required
string
>= 1 characters
value
required
string
>= 1 characters
account
required
object
id
required
string
displayName
required
Any of:
string
primaryAddress
required
Any of:
string
ensName
required
Any of:
string
stats
required
Any of:
object
volume
required
string
volumeUsd
required
Any of:
string
ownerCount
required
integer
<= 9007199254740991
tokenCount
required
integer
<= 9007199254740991
updatedAt
required
string
sales
required
Array<object>
object
id
required
string
collectionId
required
string
name
required
Any of:
string
type
required
string
Allowed values: FIXED_PRICE DUTCH_AUCTION RANKED_AUCTION CUSTOM
startAt
required
string
endAt
required
Any of:
string
price
required
string
currency
required
string
maxPerTransaction
required
integer
>= -9007199254740991 <= 9007199254740991
maxPerWallet
required
integer
>= -9007199254740991 <= 9007199254740991
maxTotal
required
integer
>= -9007199254740991 <= 9007199254740991
paymentRecipient
required
string
accessMode
required
string
Allowed values: PUBLIC GATED
gateId
required
Any of:
string
gasSponsored
required
boolean
status
required
string
Allowed values: Draft Live
paused
required
boolean
mechanicId
required
Any of:
string
typeConfig
required
Any of:
vectorId
required
Any of:
string
customMintFee
required
Any of:
string
collectorMessage
required
Any of:
string
createdAt
required
string
updatedAt
required
string

403

Section titled “403 ”

Forbidden

404

Section titled “404 ”

Not found