v1

latestOpenAPI 3.0.02026-07-17166300328.1 KB
Collections

Get a list of collections with optional filtering

post/collections/index/{filter}

Path parameters

filter'my_collections' | 'org_collections' required

Optional filter for collections

Request body

Collection.uuidstring
Collection.typestring
Collection.namestring

Example request

{
  "Collection.uuid": "c99506a6-%",
  "Collection.type": "campaign%",
  "Collection.name": "APT Campaign%"
}

Response

A list of collections

Example response

[
  {
    "Collection": {
      "id": "12345",
      "org_id": "12345",
      "orgc_id": "12345",
      "uuid": "c99506a6-1255-4b71-afa5-7b8ba48c3b1b",
      "created": "2024-03-19 11:10:24",
      "modified": "2024-03-19 11:10:24",
      "Org": {
        "id": "12345",
        "name": "ORGNAME",
        "uuid": "c99506a6-1255-4b71-afa5-7b8ba48c3b1b"
      },
      "Orgc": {
        "id": "12345",
        "name": "ORGNAME",
        "uuid": "c99506a6-1255-4b71-afa5-7b8ba48c3b1b"
      },
      "name": "APT Campaign Collection",
      "description": "This is a dummy description, for a collection about Aiur.",
      "distribution": "4",
      "sharing_group_id": "1"
    }
  }
]