Skip to main content
GET
/
api
/
v4
/
products
/
{productId}
/
images
/
{imageId}
/
scans
List Scans
curl --request GET \
  --url https://api.example.com/api/v4/products/{productId}/images/{imageId}/scans \
  --header 'Authorization: Bearer <token>'
{
  "scans": [
    {
      "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "createTime": "2024-01-01T01:00:00Z",
      "author": {
        "userId": "<string>",
        "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
        "createTime": "2024-01-01T01:00:00Z",
        "email": "[email protected]",
        "status": "active",
        "resourceType": "Org"
      },
      "parent": "<string>",
      "latestScanState": {
        "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
        "type": "new",
        "createTime": "2024-01-01T01:00:00Z",
        "parent": "<string>",
        "author": {
          "userId": "<string>",
          "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
          "createTime": "2024-01-01T01:00:00Z",
          "email": "[email protected]",
          "status": "active",
          "resourceType": "Org"
        },
        "source": "01ARZ3NDEKTSV4RRFFQ69G5FAV"
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

productId
string<ulid>
required

Product ID

Required string length: 26
Example:

"01ARZ3NDEKTSV4RRFFQ69G5FAV"

imageId
string<ulid>
required

Image ID

Required string length: 26
Example:

"01ARZ3NDEKTSV4RRFFQ69G5FAV"

Response

success

scans
object[]
required