{
  "opencollection": "1.0.0",
  "info": {
    "name": "PlanRadar's API Documentation Approval Requests V2 List API",
    "version": "2.0"
  },
  "items": [
    {
      "info": {
        "name": "List",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Returns all lists",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/:customer_id/lists/",
            "params": [
              {
                "name": "customer_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "last_sync_date",
                "value": "",
                "type": "query",
                "description": "is a Unix Timestamp. If it is set, only lists that were created after that timestamp will be returned"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query"
              },
              {
                "name": "pagesize",
                "value": "",
                "type": "query",
                "description": "sets the number of lists that should be returned per page <br/> Maximum is 500, default is 100"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "sets the number of pages for the returned lists"
              }
            ]
          },
          "docs": "This API returns all lists created by the logged in costumer.<br ><b>List Sorting: </b> <br /> Lists can be sorted by their attributes like name and creation date: created-at. The sort is always ascending unless the field name is prefixed with a minus (U+002D HYPHEN-MINUS, \"-\") i.e. `-id` or `id` <br /><b>Example#1: </b>sorting lists by descending name `/lists?sort=-name`<br /><b>Example#2: </b>sorting lists by ascending creation date `/lists?sort=created-at`"
        },
        {
          "info": {
            "name": "Creates new list",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/:customer_id/lists/",
            "params": [
              {
                "name": "customer_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API is used for creating a list with or without entries. "
        },
        {
          "info": {
            "name": "Retrieve one list",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/:customer_id/lists/:id",
            "params": [
              {
                "name": "customer_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve one list"
        },
        {
          "info": {
            "name": "Updates specific list",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/api/v1/:customer_id/lists/:id",
            "params": [
              {
                "name": "customer_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "id of the list"
              }
            ]
          },
          "docs": "This API is used for updating a specific list with or without entries based on its id. "
        },
        {
          "info": {
            "name": "Update one list with/out list entries",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/v1/:customer_id/lists/:id",
            "params": [
              {
                "name": "customer_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "list_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Update one list with/out list entries"
        },
        {
          "info": {
            "name": "Deletes specific list",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/v1/:customer_id/lists/:id",
            "params": [
              {
                "name": "customer_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "id of the list"
              }
            ]
          },
          "docs": "This API is used for deleting a specific list based on its id."
        }
      ]
    }
  ],
  "bundled": true
}