{
  "opencollection": "1.0.0",
  "info": {
    "name": "Sign In Solutions VMS AuditLogs Invites API",
    "version": "0.21.0"
  },
  "items": [
    {
      "info": {
        "name": "Invites",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create an Invite",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{domain}/locations/:location_id/invites",
            "headers": [
              {
                "name": "Idempotency-Key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "location_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new `Invite` for a specific `Location`."
        },
        {
          "info": {
            "name": "List all Invites",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{domain}/invites",
            "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": "Filters by `first_name`, `last_name`, `company`, and `email`"
              },
              {
                "name": "with_colours",
                "value": "",
                "type": "query",
                "description": "A comma separated list of case-insensitive colour values.\ni.e., `red`, `green`, `yellow`, and `orange`"
              },
              {
                "name": "location_ids",
                "value": "",
                "type": "query",
                "description": "A comma separated list of Location IDs"
              },
              {
                "name": "sort_by",
                "value": "",
                "type": "query",
                "description": "Sorts by the field name and direction provided where the pattern is `FIELD_NAME_DIRECTION`"
              },
              {
                "name": "starts_before",
                "value": "",
                "type": "query",
                "description": "Filters results to all those *before* the provided datetime"
              },
              {
                "name": "starts_after",
                "value": "",
                "type": "query",
                "description": "Filters results to all those *after* the provided datetime"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "A list of comma-separated related models to include\ni.e., 'assigned_stall'"
              },
              {
                "name": "is_approved",
                "value": "",
                "type": "query",
                "description": "True to return approved and auto approved invites, False to return pending and rejected invites"
              },
              {
                "name": "active_after",
                "value": "",
                "type": "query",
                "description": "Checks that an invite hasn't yet started, or has started and is still active after a specified time"
              },
              {
                "name": "active_before",
                "value": "",
                "type": "query",
                "description": "Checks that an invite hasn't ended before a specified time"
              }
            ]
          },
          "docs": "Gets a list of all `Invite` entities."
        },
        {
          "info": {
            "name": "Delete Multiple Invites",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{domain}/invites/batch_delete",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Queues up a \"delete\" background task for one or more `Invite` entities."
        },
        {
          "info": {
            "name": "Create an Invite from a Registration",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{domain}/registrations/:registration_id/invites",
            "headers": [
              {
                "name": "Idempotency-Key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "registration_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Creates a new `Invite` from `Registration` data."
        },
        {
          "info": {
            "name": "Get an Invite",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{domain}/invites/:invite_id",
            "params": [
              {
                "name": "invite_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "A list of comma-separated related models to include\ni.e., 'assigned_stall'"
              }
            ]
          },
          "docs": "Gets the details of a single instance of a `Invite`."
        },
        {
          "info": {
            "name": "Update an Invite",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{domain}/invites/:invite_id",
            "headers": [
              {
                "name": "Idempotency-Key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "invite_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates an existing `Invite`."
        },
        {
          "info": {
            "name": "Deletes an Invite",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{domain}/invites/:invite_id",
            "headers": [
              {
                "name": "Idempotency-Key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "invite_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Deletes a single instance of `Invite`"
        }
      ]
    }
  ],
  "bundled": true
}