Collections

with an attachment kind filter

Endpoint

GET /api/v2/collections/:uid/scans

Parameters

Name Description type default
uid required Collection uid string
with_attachment_kind Required scan attachment kind string
page Results page number 1
per_page Results per page number 30

Request

Route

GET /api/v2/collections/n4GGt1u6/scans?with_attachment_kind=labels&page=1&per_page=30

Headers

Accept: application/json
Content-Type: application/json
Access-Token: 77f9c9aa22fcfa110dcc328558d6db93963356130fd9a5f720efa47a1d862669$$QBJmqzAEQCvC1ME0Kz8FAI1yYbv/ZVRFFoaQ7jSkeWdke3kinDketQlz5A==--EP8uy6bz9SuwB8lh--iB7H5M3TcahPrpSxXOmtzg==
Api-Key: kneECer45RvVJ8qk

Query Parameters

with_attachment_kind=labels
page=1
per_page=30

Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "scans": [
    {
      "created_at": "2019-06-18T22:04:32.065Z",
      "updated_at": "2019-06-18T22:04:32.065Z",
      "uid": "tmhKWevS",
      "team_uid": "CcJiufTF",
      "tag_list": [

      ],
      "attachments": [
        {
          "created_at": "2019-06-18T22:04:32.071Z",
          "updated_at": "2019-06-18T22:04:32.071Z",
          "publicly_visible": false,
          "publicly_downloadable": false,
          "metadata": null,
          "kind": "labels",
          "uid": "vQxjnrck",
          "scan_uid": "tmhKWevS",
          "file_key": null,
          "file_url": null,
          "thumbnail_key": null,
          "thumbnail_url": null,
          "annotation_type_list": [

          ],
          "team_uid": "CcJiufTF",
          "collection_uid": null
        }
      ]
    }
  ],
  "success": true
}