List QR Code Addresses

GET /api/qrcodes

Retrieve a paginated list of QR code addresses. Supports filtering by location, status, type, and configurable sorting.

Query Parameters

Parameter	Type	Required	Description
`page`	integer	No	Page number (default: 1)
`per_page`	integer	No	Results per page (default: 20)
`order`	string	No	Sort direction: `asc` or `desc`
`order_by`	string	No	Field to sort by
`location`	string	No	Filter by location name
`status`	string	No	Filter by status: `ACTIVE` or `INACTIVE`
`type`	string	No	Filter by type: `SITE` or `CLIENT_HOME`
`deleted`	boolean	No	Filter by deleted status
`pagination`	boolean	No	Enable paginated response (default: `false`)
`with_children`	boolean	No	Include nested `qr_code_tags` and `organization` in response

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

Error Codes

Status	Meaning
400	Bad Request
401	Unauthorized
403	Access Denied or subscription required
500	Internal Server Error

Example Request

curl

curl -H "Authorization: Bearer your_api_key:your_api_secret" \
  "http://staging.didyougo.com.au/api/qrcodes?page=1&per_page=20&status=ACTIVE"

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

[
  {
    "uuid": "ABC123DEF456GHI789JKLM",
    "location": "123 Main Street, Melbourne VIC 3000",
    "latitude": -37.8136,
    "longitude": 144.9631,
    "organization_uuid": "org-uuid-here",
    "status": "ACTIVE",
    "type": "SITE",
    "name": "Main Office",
    "deleted": false,
    "created_on": "2025-01-15T10:30:00Z",
    "updated_on": "2025-01-15T10:30:00Z",
    "deleted_on": null
  }
]