Get object

Retrieve detailed information about a specific smart object by its unique identifier. This endpoint returns comprehensive object data including faces, actions, metadata, and current state information.

GET

Parameters

Path Parameters

ObjectId

REQUIRED

Status code	Description
200	object by id
400	Bad request error - the request contains invalid parameters or malformed data
404	Resource not found - the requested resource does not exist
500	Internal server error - an unexpected error occurred on the server

cURL

curl -L \
  "https://blockv-labs.io/objects/{objectId}" \
  -H 'Accept: application/json'

Response

{
  "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"
}

json

{
  "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"
      }
    }
  }
}

API Keys

Assets

Batches

Event Bus

Faces

Notifications

Objects

Organization Members

Organization Roles

Organizations

Public

Statistics

Support

Templates

Wallets

Webhooks

Get object

Parameters

Path Parameters