{
  "opencollection": "1.0.0",
  "info": {
    "name": "Smokeball Activity Codes Staff API",
    "version": "1.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "x-api-key",
      "value": "{{x-api-key}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Staff",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Search firm staff members",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.smokeball.com/staff",
            "params": [
              {
                "name": "Offset",
                "value": "",
                "type": "query"
              },
              {
                "name": "Limit",
                "value": "",
                "type": "query"
              },
              {
                "name": "Search",
                "value": "",
                "type": "query",
                "description": " Available fields: email, name"
              },
              {
                "name": "Fields",
                "value": "",
                "type": "query",
                "description": " Available fields: rate"
              }
            ]
          },
          "docs": "Retrieves a paginated list of staff members (filtered based on search parameters provided) in the firm associated with the authenticated client."
        },
        {
          "info": {
            "name": "Create firm staff member",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.smokeball.com/staff",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a staff member in the firm associated with the authenticated client."
        },
        {
          "info": {
            "name": "Get firm staff member",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.smokeball.com/staff/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieves a staff member (based on staff id parameter provided) in the firm associated with the authenticated client."
        },
        {
          "info": {
            "name": "Update firm staff member",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.smokeball.com/staff/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a staff member in the firm associated with the authenticated client."
        },
        {
          "info": {
            "name": "Deletes a firm staff member",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.smokeball.com/staff/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Sets the staff member from the firm associated with the authenticated client as a former staff member.\r\n\r\nThe staff member is set as a former staff member and if they are a user, becomes a former user. User access is also disabled."
        }
      ]
    }
  ],
  "bundled": true
}