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/NsidXJEy/scans?with_attachment_kind=labels&page=1&per_page=30

Headers

Accept: application/json
Content-Type: application/json
Access-Token: 0d43a381aee5cf23c94ec937670a33cdac66c38b907f3622f2d06bcb6153d0eb$$c/uRvdT3DSVEfOqbBHyf5hoqIwp6gJ6woxsk8Cumuyflz3Dv4GEpkxv+7g==--6+kBTvNFDB3z9CxU--4PjAR1kss+6YtX0GaJckNg==
Api-Key: JneE617tSRvi3h7Q

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": "2020-06-01T21:44:45.269Z",
      "updated_at": "2020-06-01T21:44:45.269Z",
      "uid": "6HHHFiAR",
      "team_uid": "F9zQnbqF",
      "tag_list": [

      ],
      "attachments": [
        {
          "created_at": "2020-06-01T21:44:45.274Z",
          "updated_at": "2020-06-01T21:44:45.274Z",
          "publicly_visible": false,
          "publicly_downloadable": false,
          "metadata": null,
          "kind": "labels",
          "uid": "g2kwYD7e",
          "scan_uid": "6HHHFiAR",
          "file_key": null,
          "file_url": null,
          "thumbnail_key": null,
          "thumbnail_url": null,
          "annotation_type_list": [

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