List QR Code Tags

GET /api/qrcode-tags

Retrieve a paginated list of QR code tags. Tags represent location/service points within QR code addresses (e.g. entrances, wards, client sites).

Query Parameters

Parameter	Type	Required	Description
`qr_code_uuid`	string	No	Filter by parent QR code address UUID
`tag_name`	string	No	Filter by internal client name
`tag_number`	string	No	Filter by client number
`status`	string	No	Filter by status: `ACTIVE`, `INACTIVE`
`type`	string	No	Filter by type: `SITE`, `CLIENT`
`page`	integer	No	Page number (default: `1`)
`per_page`	integer	No	Items per page (default: `50`)
`order`	string	No	Sort direction: `asc` or `desc`
`order_by`	string	No	Field to sort by
`pagination`	boolean	No	Enable paginated response (default: `false`)
`with_children`	boolean	No	Include nested child objects in response

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

Error Codes

Status	Meaning
400	Bad Request
401	Unauthorized
500	Internal Server Error

Example Request

curl

curl -X GET "http://staging.didyougo.com.au/api/qrcode-tags?type=SITE&status=ACTIVE" \
  -H "Authorization: Bearer your_api_key:your_api_secret"

Try It

Try it

Authorization Required

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

Query Parameters

API Response

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

Example Response

json

{
  "items": [
    {
      "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
    }
  ],
  "page": 1,
  "per_page": 50,
  "total": 1,
  "pages": 1
}