{
  "opencollection": "1.0.0",
  "info": {
    "name": "When I Work API Documentation Accounts Annotations API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Annotations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Annotations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.wheniwork.com/2/annotations",
            "params": [
              {
                "name": "start_date",
                "value": "",
                "type": "query",
                "description": "Optional start date to filter by (defaults to the beginning of today)"
              },
              {
                "name": "end_date",
                "value": "",
                "type": "query",
                "description": "Optional end date to filter by (defaults to the beginning of the day one year from start date)"
              },
              {
                "name": "locations",
                "value": "",
                "type": "query",
                "description": "Optional list of location IDs to filter by (defaults to all locations)"
              },
              {
                "name": "no_time_off",
                "value": "",
                "type": "query",
                "description": "Optional flag to filter to only annotations that don't allow time-off (defaults to false)"
              }
            ]
          },
          "docs": "List all the annotations in the specified date range"
        },
        {
          "info": {
            "name": "Create Annotation",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.wheniwork.com/2/annotations",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Used to create an annotation"
        },
        {
          "info": {
            "name": "Get Annotation",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.wheniwork.com/2/annotations/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the annotation"
              }
            ]
          },
          "docs": "Get a single shift annotation by ID"
        },
        {
          "info": {
            "name": "Update Annotation",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.wheniwork.com/2/annotations/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the annotation"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a single annotation"
        },
        {
          "info": {
            "name": "Delete Annotation",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.wheniwork.com/2/annotations/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the annotation"
              }
            ]
          },
          "docs": "Delete an existing annotation when no longer needed. This operation cannot be undone."
        }
      ]
    }
  ],
  "bundled": true
}