{
  "opencollection": "1.0.0",
  "info": {
    "name": "ALTR Management Administrators API",
    "version": "12.25.1"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "administrators",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List administrators in organization.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://altrnet.live.altr.com/api/administrators",
            "params": [
              {
                "name": "offset",
                "value": "",
                "type": "query"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query"
              },
              {
                "name": "orderBy",
                "value": "",
                "type": "query"
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The value you want to sort by."
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Retrieve administrators by their status."
              },
              {
                "name": "username",
                "value": "",
                "type": "query",
                "description": "Filter administrators by their username"
              }
            ]
          },
          "docs": "Lists all the administrators in the organization, in the order of their last name (by default, can be changed with filters)."
        },
        {
          "info": {
            "name": "Creates a new administrators and invites them to the organization.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://altrnet.live.altr.com/api/administrators",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new administrators that will be added to the organization. This will send them an e-mail invite and the new administrator will be in the 'pending' status until they set their password."
        },
        {
          "info": {
            "name": "Returns a single administrators by the id given.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://altrnet.live.altr.com/api/administrators/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Returns a single administrators by the id given."
        },
        {
          "info": {
            "name": "Updates an administrator.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://altrnet.live.altr.com/api/administrators/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates an administrator. Can be used to update oneself or other administrators. Can also be used to unlock an administrator who's account is locked out and update roles. Roles permissions are take into account when updating administrators."
        },
        {
          "info": {
            "name": "For a pending user, resend's them an e-mail with a newly generated token.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://altrnet.live.altr.com/api/administrators/resend-token",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Resend's and generates a new user e-mail to the pending user."
        }
      ]
    }
  ],
  "bundled": true
}