Skip to content
Highlight Docs

List tokens

GET
/collection/{highlightId}/tokens

Get a paginated list of minted tokens for a collection. Returns tokens for public collections without authentication. Supports filtering by owner address and by trait attributes.

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)$/

Query Parameters

Section titled “Query Parameters ”
page
integer
default: 1 > 0 <= 9007199254740991
limit
integer
default: 20 > 0 <= 100
sort
string
default: tokenId
Allowed values: tokenId name mintedAt createdAt
order
string
default: asc
Allowed values: asc desc
ownerAddress
string
search
string
attributes
string

Trait filter as a JSON-encoded array of { traitType, values }. AND across entries, OR within a trait’s values. Example: [{“traitType”:“Background”,“values”:[“Blue”,“Red”]}].

Responses

Section titled “ Responses ”

200

Section titled “200 ”

List of tokens

object
items
required
Array<object>
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)$/
collectionId
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)$/
tokenId
required
string
status
required
string
Allowed values: PendingReveal PendingIndex Ready FailedReveal FailedIndex
name
required
Any of:
string
description
required
Any of:
string
externalUrl
required
Any of:
string
attributes
required
Any of:
Array<object>
object
trait_type
required
string
value
required
Any of:
string
display_type
string
properties
required
Any of:
object
key
additional properties
imageMediaId
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)$/
imageMedia
required
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 External
role
required
string
Allowed values: Origin Archive Mirror
reference
required
string
url
required
Any of:
string format: uri
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
createdAt
required
string
updatedAt
required
string
animationMediaId
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)$/
animationMedia
required
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 External
role
required
string
Allowed values: Origin Archive Mirror
reference
required
string
url
required
Any of:
string format: uri
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
createdAt
required
string
updatedAt
required
string
mintedAt
required
Any of:
string
createdAt
required
string
updatedAt
required
string
pageInfo
required
object
page
required
integer
> 0 <= 9007199254740991
limit
required
integer
> 0 <= 9007199254740991
totalCount
required
integer
<= 9007199254740991
totalPages
required
integer
<= 9007199254740991
hasNextPage
required
boolean
hasPreviousPage
required
boolean

400

Section titled “400 ”

Malformed attributes filter

404

Section titled “404 ”

Collection not found or not public