List objects
Retrieve a paginated list of smart objects accessible to the authenticated user. This endpoint supports comprehensive filtering by various criteria including object type, ownership, location, template associations, and temporal ranges. Objects can be filtered by faces, actions, ownership, geographical location, and creation/modification timestamps.
GET
Parameters
Query Parameters
Id
Filter resources by their unique identifier
Org_id
Filter resources by the organization they belong to
Limit
How many items to return at one time (max 100)
Next
Pagination token for retrieving the next page of results
Order
Sort order for the results (ascending or descending)
SortBy
Field name to sort the results by
Faces
Optional flag for face objects
Actions
Optional flag for action objects
Owner
Filter by the owner's address
Fqdn
Filter objects by fully qualified domain name
Dropped
Optional flag for dropped items
Geo_hash
Geographical hash for location-based filtering
Template_id
Filter by the collection ID
When_created[$gt]
Filter objects created after this date and time
When_created[$gte]
Filter objects created after this date and time
When_created[$lt]
Filter objects created before this date and time
When_created[$lte]
When_modified[$gt]
When_modified[$lt]
When_modified[$gte]
When_modified[$lte]
| Status code | Description |
|---|---|
| 200 | list of objects |
| 400 | Bad request error - the request contains invalid parameters or malformed data |
| 500 | Internal server error - an unexpected error occurred on the server |
cURL
curl -L \"https://blockv-labs.io/objects?id={id}&org_id={org_id}&limit={limit}&next={next}&order={order}&sortBy={sortBy}&faces={faces}&actions={actions}&owner={owner}&fqdn={fqdn}&dropped={dropped}&geo_hash={geo_hash}&template_id={template_id}&when_created[$gt]={when_created[$gt]}&when_created[$gte]={when_created[$gte]}&when_created[$lt]={when_created[$lt]}&when_created[$lte]={when_created[$lte]}&when_modified[$gt]={when_modified[$gt]}&when_modified[$lt]={when_modified[$lt]}&when_modified[$gte]={when_modified[$gte]}&when_modified[$lte]={when_modified[$lte]}" \-H 'Accept: application/json'
Response
{"objects": [{"id": "string","org_id": "string","chain": {"contract_address": "SP000000000000000000002Q6VF78.pox-3","network": "string","chain_id": 144000},"custom_hash": "string","metadata": {"name": "string","description": "string","category": "string","image": {"id": "string","name": "string","type": "string","url": "string","hash": "string","is_public": false,"when_created": "2024-01-01T00:00:00Z"},"edition": 0},"assets": [{"id": "string","name": "string","type": "string","url": "string","hash": "string","is_public": false,"when_created": "2024-01-01T00:00:00Z"}],"owner": "string","template_id": "string","location": {"latitude": 0,"longitude": 0,"geo_hash": "string"},"nonce": 0,"version": 0,"state_root": "string","integrity_root": "string","when_created": "2024-01-01T00:00:00Z","when_modified": "2024-01-01T00:00:00Z"}],"faces": [{"template_id": "string","face": {"id": "string","url": "string","content": "string"}}],"actions": [{"template_id": "string","actions": ["string"]}],"next": "string"}
json
{"type": "object","required": ["objects"],"properties": {"objects": {"type": "array","description": "Array of objects.","items": {"type": "object","description": "Smart object entity representing a blockchain-based digital asset with metadata and state management","required": ["id","org_id","template_id","metadata","owner","state_root","nonce","version","when_modified","when_created"],"properties": {"id": {"type": "string","description": "Unique identifier for the smart object","x-oapi-codegen-extra-tags": {"bson": "_id","json": "id"},"x-go-type": "id.ID","x-go-type-import": {"path": "github.com/vlabsio/smarttoken/pkg/types/id"},"x-go-type-skip-optional-pointer": true},"org_id": {"type": "string","description": "Organization identifier that owns this smart object","x-oapi-codegen-extra-tags": {"bson": "org_id"},"x-go-type": "id.ID","x-go-type-import": {"path": "github.com/vlabsio/smarttoken/pkg/types/id"},"x-go-type-skip-optional-pointer": true},"chain": {"description": "Reference to the chain information","x-oapi-codegen-extra-tags": {"bson": "chain"},"type": "object","required": ["contract_address","network","chain_id"],"properties": {"contract_address": {"type": "string","description": "Address of the blockchain contract.","x-oapi-codegen-extra-tags": {"bson": "contract_address"}},"network": {"type": "string","description": "Name of the blockchain network (e.g., Ethereum, Binance Smart Chain).","x-oapi-codegen-extra-tags": {"bson": "network"}},"chain_id": {"type": "integer","description": "Unique identifier for the blockchain chain.","x-oapi-codegen-extra-tags": {"bson": "chain_id"}}}},"custom": {"type": "object","description": "Custom properties of the object","x-go-type": "map[string]interface{}","x-go-type-skip-optional-pointer": true,"x-oapi-codegen-extra-tags": {"bson": "custom"}},"custom_hash": {"type": "string","description": "Custom hash for the object","x-oapi-codegen-extra-tags": {"bson": "custom_hash,omitempty"}},"metadata": {"type": "object","properties": {"name": {"type": "string","description": "Name of the object","x-go-type-skip-optional-pointer": true,"x-oapi-codegen-extra-tags": {"bson": "name,omitempty"}},"description": {"type": "string","description": "Description of the object","x-go-type-skip-optional-pointer": true,"x-oapi-codegen-extra-tags": {"bson": "description,omitempty"}},"category": {"type": "string","description": "Category of the object","x-go-type-skip-optional-pointer": true,"x-oapi-codegen-extra-tags": {"bson": "category,omitempty"}},"image": {"type": "object","description": "Represents a file or media asset stored in the platform","required": ["id","url"],"properties": {"id": {"type": "string","description": "Unique identifier for the asset","x-oapi-codegen-extra-tags": {"bson": "id,omitempty"}},"name": {"type": "string","description": "Human-readable name of the asset","x-oapi-codegen-extra-tags": {"bson": "name,omitempty"}},"type": {"type": "string","description": "MIME type of the asset (e.g., image/jpeg, application/pdf)","x-oapi-codegen-extra-tags": {"bson": "type,omitempty"}},"url": {"type": "string","description": "Public URL where the asset can be accessed","x-oapi-codegen-extra-tags": {"bson": "url,omitempty"}},"hash": {"type": "string","description": "Cryptographic hash of the asset content for integrity verification","x-oapi-codegen-extra-tags": {"bson": "hash,omitempty"}},"is_public": {"type": "boolean","description": "Whether the asset is publicly accessible without authentication","x-oapi-codegen-extra-tags": {"bson": "is_public,omitempty"}},"when_created": {"type": "string","format": "date-time","description": "Timestamp when the asset was uploaded","x-oapi-codegen-extra-tags": {"bson": "when_created,omitempty"}}}},"edition": {"type": "integer","description": "Edition number of the object","x-go-type-skip-optional-pointer": true,"x-oapi-codegen-extra-tags": {"bson": "edition,omitempty"}}},"x-oapi-codegen-extra-tags": {"bson": "metadata,omitempty"},"description": "Metadata information for the object","x-go-type-skip-optional-pointer": true},"assets": {"type": "array","items": {"type": "object","description": "Represents a file or media asset stored in the platform","required": ["id","url"],"properties": {"id": {"type": "string","description": "Unique identifier for the asset","x-oapi-codegen-extra-tags": {"bson": "id,omitempty"}},"name": {"type": "string","description": "Human-readable name of the asset","x-oapi-codegen-extra-tags": {"bson": "name,omitempty"}},"type": {"type": "string","description": "MIME type of the asset (e.g., image/jpeg, application/pdf)","x-oapi-codegen-extra-tags": {"bson": "type,omitempty"}},"url": {"type": "string","description": "Public URL where the asset can be accessed","x-oapi-codegen-extra-tags": {"bson": "url,omitempty"}},"hash": {"type": "string","description": "Cryptographic hash of the asset content for integrity verification","x-oapi-codegen-extra-tags": {"bson": "hash,omitempty"}},"is_public": {"type": "boolean","description": "Whether the asset is publicly accessible without authentication","x-oapi-codegen-extra-tags": {"bson": "is_public,omitempty"}},"when_created": {"type": "string","format": "date-time","description": "Timestamp when the asset was uploaded","x-oapi-codegen-extra-tags": {"bson": "when_created,omitempty"}}}},"description": "List of assets associated with the object","x-go-type-skip-optional-pointer": true,"x-oapi-codegen-extra-tags": {"bson": "assets"}},"owner": {"type": "string","description": "ID of the owner of the object","x-oapi-codegen-extra-tags": {"bson": "owner"}},"template_id": {"type": "string","description": "Template identifier that defines the structure and behavior of this smart object","x-oapi-codegen-extra-tags": {"bson": "template_id"},"x-go-type": "id.ID","x-go-type-import": {"path": "github.com/vlabsio/smarttoken/pkg/types/id"},"x-go-type-skip-optional-pointer": true},"location": {"description": "Location information for the object","x-go-type-skip-optional-pointer": true,"x-oapi-codegen-extra-tags": {"bson": "location"},"type": "object","required": ["latitude","longitude","geo_hash"],"properties": {"latitude": {"type": "number","format": "double","description": "Latitude coordinate in decimal degrees","x-oapi-codegen-extra-tags": {"bson": "latitude"}},"longitude": {"type": "number","format": "double","description": "Longitude coordinate in decimal degrees","x-oapi-codegen-extra-tags": {"bson": "longitude"}},"geo_hash": {"type": "string","description": "Geohash string for efficient location-based queries","x-oapi-codegen-extra-tags": {"bson": "geo_hash"}}}},"nonce": {"type": "integer","description": "Nonce value for the object","x-oapi-codegen-extra-tags": {"bson": "nonce"}},"version": {"type": "integer","description": "Version of the object","x-oapi-codegen-extra-tags": {"bson": "version"}},"state_root": {"type": "string","description": "Merkle root of the object","x-oapi-codegen-extra-tags": {"bson": "state_root"}},"integrity_root": {"type": "string","description": "Merkle root of the integrity data","x-oapi-codegen-extra-tags": {"bson": "integrity_root"}},"when_created": {"type": "string","format": "date-time","description": "Timestamp of when the object was created","x-oapi-codegen-extra-tags": {"bson": "when_created"}},"when_modified": {"type": "string","format": "date-time","description": "Timestamp of the last modification","x-oapi-codegen-extra-tags": {"bson": "when_modified"}}}}},"faces": {"type": "array","description": "Array of object faces.","items": {"type": "object","required": ["template_id","face"],"properties": {"template_id": {"type": "string","description": "The ID of the template"},"face": {"type": "object","properties": {"id": {"type": "string","description": "The ID of the face"},"url": {"type": "string","description": "The URL of the face image"},"config": {"type": "object","description": "Additional data associated with the face"},"content": {"type": "string","description": "The content of the face"}}}}},"x-go-type-skip-optional-pointer": true},"actions": {"type": "array","description": "Array of object actions.","items": {"type": "object","required": ["template_id","actions"],"properties": {"template_id": {"type": "string","description": "The ID of the template"},"actions": {"type": "array","items": {"type": "string"},"description": "List of actions associated with the template"}}},"x-go-type-skip-optional-pointer": true},"next": {"type": "string","description": "Pagination token for the next set of results, if any.","x-go-type-skip-optional-pointer": true}}}