Profiles API
Manage tag profiles including item details, pet info, vehicle info, device info, travel info, and photos.
Every activated tag has a profile that contains the information displayed when someone scans it. Profiles support different data depending on the tag type (general, pet, vehicle, device, travel). All endpoints require authentication.
Get Profile
GET /api/v1/profiles/:tagId — Required
Update Profile
PATCH /api/v1/profiles/:tagId — Required
Pet Profile
PUT /api/v1/profiles/:tagId/pet — Required
Vehicle Profile
PUT /api/v1/profiles/:tagId/vehicle — Required
Device Profile
PUT /api/v1/profiles/:tagId/device — Required
Travel Profile
PUT /api/v1/profiles/:tagId/travel — Required
Photos
POST / DELETE /api/v1/profiles/:tagId/photos — Required
Get Profile
Retrieve the profile for a specific tag.
GET /api/v1/profiles/:tagId — Auth: Required
curl https://api.qriotag.global/api/v1/profiles/tag_abc123 \
-H "Authorization: Bearer <token>"Response
{
"success": true,
"data": {
"tagId": "tag_abc123",
"itemName": "House Keys",
"description": "Set of 3 keys on a blue lanyard",
"ownerName": "Jane",
"contactEmail": "jane@example.com",
"contactPhone": "+1234567890",
"visibility": "PUBLIC",
"photos": [
{
"id": "pht_001",
"url": "https://cdn.qriotag.com/photos/pht_001.jpg",
"isPrimary": true
}
],
"tagType": "GENERAL"
}
}Update Profile
Update the general profile information for a tag.
PATCH /api/v1/profiles/:tagId — Auth: Required
Request body
| Field | Type | Required | Description |
|---|---|---|---|
itemName | string | No | Name of the tagged item |
description | string | No | Description of the item |
ownerName | string | No | Owner's display name |
contactEmail | string | No | Contact email shown to finders |
contactPhone | string | No | Contact phone shown to finders |
visibility | string | No | PUBLIC or PRIVATE |
curl -X PATCH https://api.qriotag.global/api/v1/profiles/tag_abc123 \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"itemName": "House & Car Keys",
"description": "Set of 3 house keys and 1 car key on a blue lanyard",
"ownerName": "Jane D.",
"visibility": "PUBLIC"
}'Response
{
"success": true,
"data": {
"tagId": "tag_abc123",
"itemName": "House & Car Keys",
"description": "Set of 3 house keys and 1 car key on a blue lanyard",
"ownerName": "Jane D.",
"contactEmail": "jane@example.com",
"visibility": "PUBLIC"
}
}Update Pet Profile
Set or update pet-specific profile data for a pet tag.
PUT /api/v1/profiles/:tagId/pet — Auth: Required
Request body
| Field | Type | Required | Description |
|---|---|---|---|
petName | string | Yes | Pet's name |
species | string | Yes | Species (e.g., dog, cat) |
breed | string | No | Breed |
color | string | No | Color or markings |
microchip | string | No | Microchip ID number |
vetInfo | string | No | Veterinarian name and contact |
curl -X PUT https://api.qriotag.global/api/v1/profiles/tag_abc123/pet \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"petName": "Max",
"species": "dog",
"breed": "Golden Retriever",
"color": "Golden",
"microchip": "985121012345678",
"vetInfo": "Dr. Smith at Downtown Vet Clinic, (555) 123-4567"
}'Response
{
"success": true,
"data": {
"tagId": "tag_abc123",
"tagType": "PET",
"petName": "Max",
"species": "dog",
"breed": "Golden Retriever",
"color": "Golden",
"microchip": "985121012345678",
"vetInfo": "Dr. Smith at Downtown Vet Clinic, (555) 123-4567"
}
}Update Vehicle Profile
Set or update vehicle-specific profile data.
PUT /api/v1/profiles/:tagId/vehicle — Auth: Required
Request body
| Field | Type | Required | Description |
|---|---|---|---|
make | string | Yes | Vehicle manufacturer |
model | string | Yes | Vehicle model |
year | integer | No | Model year |
color | string | No | Vehicle color |
licensePlate | string | No | License plate number |
vin | string | No | Vehicle Identification Number |
curl -X PUT https://api.qriotag.global/api/v1/profiles/tag_abc123/vehicle \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"make": "Toyota",
"model": "Camry",
"year": 2023,
"color": "Silver",
"licensePlate": "ABC-1234",
"vin": "1HGBH41JXMN109186"
}'Response
{
"success": true,
"data": {
"tagId": "tag_abc123",
"tagType": "VEHICLE",
"make": "Toyota",
"model": "Camry",
"year": 2023,
"color": "Silver",
"licensePlate": "ABC-1234",
"vin": "1HGBH41JXMN109186"
}
}Update Device Profile
Set or update device-specific profile data.
PUT /api/v1/profiles/:tagId/device — Auth: Required
Request body
| Field | Type | Required | Description |
|---|---|---|---|
deviceType | string | Yes | Type of device (e.g., laptop, phone, tablet) |
brand | string | No | Device brand |
model | string | No | Device model |
serialNumber | string | No | Serial number |
color | string | No | Device color |
curl -X PUT https://api.qriotag.global/api/v1/profiles/tag_abc123/device \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"deviceType": "laptop",
"brand": "Apple",
"model": "MacBook Pro 16",
"serialNumber": "C02ZX1ABCDEF",
"color": "Space Gray"
}'Response
{
"success": true,
"data": {
"tagId": "tag_abc123",
"tagType": "DEVICE",
"deviceType": "laptop",
"brand": "Apple",
"model": "MacBook Pro 16",
"serialNumber": "C02ZX1ABCDEF",
"color": "Space Gray"
}
}Update Travel Profile
Set or update travel-specific profile data (for luggage tags).
PUT /api/v1/profiles/:tagId/travel — Auth: Required
Request body
| Field | Type | Required | Description |
|---|---|---|---|
luggageType | string | Yes | Type of luggage (e.g., suitcase, backpack, duffel) |
color | string | No | Luggage color |
brand | string | No | Luggage brand |
flightNumber | string | No | Current flight number |
destination | string | No | Travel destination |
curl -X PUT https://api.qriotag.global/api/v1/profiles/tag_abc123/travel \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"luggageType": "suitcase",
"color": "Black",
"brand": "Samsonite",
"flightNumber": "AA1234",
"destination": "Los Angeles, CA"
}'Response
{
"success": true,
"data": {
"tagId": "tag_abc123",
"tagType": "TRAVEL",
"luggageType": "suitcase",
"color": "Black",
"brand": "Samsonite",
"flightNumber": "AA1234",
"destination": "Los Angeles, CA"
}
}Photos
Was this page helpful?