GitHubX

Scans

Get user scans

get

Get all scans for the authenticated user with pagination and sorting

Authorizations
Query parameters
pageinteger · min: 1Optional

Page number for pagination

Default: 1
limitinteger · min: 1 · max: 100Optional

Number of items per page

Default: 10
sortstring · enumOptional

Sort order by timestamp

Default: descPossible values:
Responses
200

User scans retrieved successfully

application/json
get
GET /api/v1/user/scans HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "scans": [
    {
      "id": "text",
      "lat": 1,
      "long": 1,
      "scanUrl": "text",
      "timestamp": "2025-10-09T22:46:08.820Z",
      "status": "text",
      "title": "text",
      "category": "text",
      "location": "text",
      "fileType": "text",
      "previewImageUrl": "text",
      "timeOfDay": "text",
      "weather": "text"
    }
  ],
  "pagination": {
    "total": 1,
    "page": 1,
    "limit": 1,
    "totalPages": 1
  }
}

Get public scans

get

Get all public scans with pagination

Authorizations
Query parameters
pageinteger · min: 1Optional

Page number for pagination

Default: 1
limitinteger · min: 1 · max: 100Optional

Number of items per page

Default: 10
Responses
200

Public scans retrieved successfully

application/json
get
GET /api/v1/scans/public-scans HTTP/1.1
Host: 
x-app-api-key: YOUR_API_KEY
Accept: */*

{
  "scans": [
    {
      "id": "text",
      "lat": 1,
      "long": 1,
      "scanUrl": "text",
      "timestamp": "2025-10-09T22:46:08.820Z",
      "status": "text",
      "title": "text",
      "category": "text",
      "location": "text",
      "fileType": "text",
      "previewImageUrl": "text",
      "timeOfDay": "text",
      "weather": "text"
    }
  ],
  "pagination": {
    "total": 1,
    "page": 1,
    "limit": 1,
    "totalPages": 1
  }
}
PreviousLeaderboardsNextModels