List entity qrcodes

GET

https://api.sureshake.com/v2/entities/{entityId}/qr-codes

Path parameters

entityId
string
required
format: uuid

Query parameters

qrType
optional
profile
or
verification
or
contact
or
claim
or
document
includeInactive
optional
boolean
default: false

Returns

200

Default Response

JSON

data
array of
object
required
- id
  string
  required
  format: uuid
- entityId
  string
  required
  format: uuid
- qrType
  profile
  or
  verification
  or
  contact
  or
  claim
  or
  document
  required
- uniqueCode
  string
  required
- qrImageUrl
  string
  or null
  required
- targetUrl
  string
  required
- accessLevel
  open
  or
  restricted
  or
  authenticated
  required
- scanCount
  integer
  or null
  required
- lastScannedAt
  string
  or null
  required
  format: date-time
- expiresAt
  string
  or null
  required
  format: date-time
- isActive
  boolean
  or null
  required
- createdBy
  string
  or null
  required
- createdAt
  string
  required
  format: date-time
- updatedAt
  string
  required
  format: date-time
}
meta
object
required
- total
  number
  required
  Total number of items available
- limit
  number
  required
  Number of items per page
- offset
  number
  required
  Number of items skipped
- hasMore
  boolean
  required
  Whether more items are available
- page
  optional
  number
  Current page number
- totalPages
  optional
  number
  Total number of pages
}

400

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

401

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

403

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

404

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

500

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

503

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

{ "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5", "qrType": "profile", "uniqueCode": "string", "qrImageUrl": "string", "targetUrl": "string", "accessLevel": "open", "scanCount": 0, "lastScannedAt": "2019-08-24T14:15:22Z", "expiresAt": "2019-08-24T14:15:22Z", "isActive": true, "createdBy": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ], "meta": { "total": 0, "limit": 0, "offset": 0, "hasMore": true, "page": 0, "totalPages": 0 } }