{
  "opencollection": "1.0.0",
  "info": {
    "name": "Sign In Solutions VMS AuditLogs Watchlists API",
    "version": "0.21.0"
  },
  "items": [
    {
      "info": {
        "name": "Watchlists",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get a Watchlist",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{domain}/watchlists/:watchlist_id",
            "params": [
              {
                "name": "watchlist_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "A list of comma-separated related models to include"
              }
            ]
          },
          "docs": "Gets the details of a single instance of a `Watchlist`."
        },
        {
          "info": {
            "name": "Update a Watchlist",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{domain}/watchlists/:watchlist_id",
            "headers": [
              {
                "name": "Idempotency-Key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "watchlist_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an existing `Watchlist` record. Every operation against this endpoint is recorded in the audit log."
        },
        {
          "info": {
            "name": "Deletes a Watchlist",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{domain}/watchlists/:watchlist_id",
            "headers": [
              {
                "name": "Idempotency-Key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "watchlist_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Deletes a single instance of `Watchlist`"
        },
        {
          "info": {
            "name": "List all Watchlists",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{domain}/watchlists",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Limits the results to a specified number, defaults to 50"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Offsets the results to a specified number, defaults to 0"
              },
              {
                "name": "query",
                "value": "",
                "type": "query",
                "description": "Query the results by `first_name`, `last_name`, `email`, `colour`, and `notes` all at once."
              },
              {
                "name": "with_colours",
                "value": "",
                "type": "query",
                "description": "A comma separated list of case-insensitive colour values.\ni.e., `red`, `green`, `yellow`, and `orange`"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "A list of comma-separated related models to include"
              }
            ]
          },
          "docs": "Gets a list of all `Watchlist` entities."
        },
        {
          "info": {
            "name": "Create Watchlist",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{domain}/watchlists",
            "headers": [
              {
                "name": "Idempotency-Key",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new `Watchlist` record. Please note, every action taken against this endpoint is recorded in the audit log."
        }
      ]
    }
  ],
  "bundled": true
}