{
  "opencollection": "1.0.0",
  "info": {
    "name": "Permitting & Licensing Record Guests API",
    "version": "v2"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Record Guests",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List record guests",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.plce.opengov.com/plce/v2/:community/records/:recordID/guests"
          },
          "docs": "List all guests associated with a record.\n\n### Permissions Required\n`Record Read`"
        },
        {
          "info": {
            "name": "Add a guest",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.plce.opengov.com/plce/v2/:community/records/:recordID/guests",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add a new guest to the record. Records can have multiple guests but only one applicant.\n\nA record can have up to 10 guests. If the limit is exceeded, the API will return a `422 Unprocessable Entity`.\n\n### Permissions Required\n`Record Write`"
        },
        {
          "info": {
            "name": "Retrieve a guest",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.plce.opengov.com/plce/v2/:community/records/:recordID/guests/:userID",
            "params": [
              {
                "name": "userID",
                "value": "",
                "type": "path",
                "description": "ID of the user"
              }
            ]
          },
          "docs": "Retrieve a guest user on a record.\n### Permissions Required\n`Record Read`"
        },
        {
          "info": {
            "name": "Remove a guest",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.plce.opengov.com/plce/v2/:community/records/:recordID/guests/:userID",
            "params": [
              {
                "name": "userID",
                "value": "",
                "type": "path",
                "description": "ID of the user"
              }
            ]
          },
          "docs": "Remove a guest from a record. Note that the applicant cannot be removed through this endpoint.\n### Permissions Required\n`Record Write`"
        }
      ]
    }
  ],
  "bundled": true
}