Get QR Code Tag

Get QR Code Tag

GET /api/qrcode-tags/uuid/{uuid}

Retrieve a single QR code tag by its UUID. Returns the full tag object including service alert recipients and linked booklets.

Path Parameters

ParameterTypeRequiredDescription
uuidstringYesUUID of the QR code tag

Response Fields

FieldTypeDescription
uuidstringTag UUID
qr_code_uuidstringParent QR code address UUID
tag_display_namestringDisplay name for the client
tag_namestringInternal name of the client
tag_numberstringUnique number assigned to the client
typestringTag type: SITE or CLIENT
statusstringStatus: ACTIVE or INACTIVE
deletedbooleanSoft-delete flag
is_favouritebooleanWhether this client is a favourite
created_onstringCreation timestamp
updated_onstringLast update timestamp
deleted_onstringDeletion timestamp (if deleted)

See Errors & Rate Limits for the common error contract used across the API.

Error Codes

StatusMeaning
401Unauthorized
404Not Found — tag does not exist
500Internal Server Error

Example Request

curl
curl -H "Authorization: Bearer your_api_key:your_api_secret" \
  http://staging.didyougo.com.au/api/qrcode-tags/uuid/XYZ789UVW123RST456MNOP

Try It

Try it

Requests are sent without cookies — you must provide a valid Bearer <api_key>:<api_secret> header.

API Response
Click the Send API Request button above and see the response here!

Example Response

json
{
  "uuid": "XYZ789UVW123RST456MNOP",
  "qr_code_uuid": "ABC123DEF456GHI789JKLM",
  "tag_display_name": "Main Entrance",
  "tag_name": "entrance-01",
  "tag_number": "TAG-001",
  "type": "SITE",
  "status": "ACTIVE",
  "deleted": false,
  "is_favourite": false,
  "created_on": "2025-01-15T10:30:00Z",
  "updated_on": "2025-01-15T10:30:00Z",
  "deleted_on": null
}