{
  "opencollection": "1.0.0",
  "info": {
    "name": "Argyle API Accounts Invites API",
    "version": "2.0"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Invites",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all invites",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v2/invites",
            "params": [
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Filter invites by [status](#object-status).\n\nMultiple status values can be searched at once using either method:\n\n1. `/v2/invites?status=sent,initiated`\n2. `/v2/invites?status=sent&status=initiated`\n"
              },
              {
                "name": "reply_to",
                "value": "",
                "type": "query",
                "description": "Filter invites for a specific [`reply_to`](#object-reply_to) email."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of invite objects returned [per page](/api-guide/overview#pagination). Default: 10. Maximum: 200."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "The URL returned in `next` or `previous` used to retrieve another [page](/api-guide/overview#pagination) of results."
              }
            ]
          },
          "docs": "Returns an object containing all invite objects."
        },
        {
          "info": {
            "name": "Send an invite",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v2/invites",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Immediately sends an invite via email, SMS, or both.\nReturns an invite object in the response.\n"
        },
        {
          "info": {
            "name": "Retrieve an invite",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v2/invites/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the invite to be retrieved."
              }
            ]
          },
          "docs": "Retrieves an invite object."
        },
        {
          "info": {
            "name": "Re-send an invite",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v2/invites/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the invite to be re-sent."
              }
            ]
          },
          "docs": "Re-sends a previously sent invite. Updates the `updated_at` and `invited_at` time.\n"
        },
        {
          "info": {
            "name": "Revoke an invite",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v2/invites/:id/revoke",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the invite to be revoked."
              }
            ]
          },
          "docs": "Invalidates a previously sent invite.\n\nIf a user clicks a revoked invite URL, the landing page will notify the user the invite has expired.\n"
        }
      ]
    }
  ],
  "bundled": true
}