{
  "opencollection": "1.0.0",
  "info": {
    "name": "PlanRadar's API Documentation Approval Requests V2 Users V1 API",
    "version": "2.0"
  },
  "items": [
    {
      "info": {
        "name": "Users V1",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Returns all users of a customer",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/:customer_id/users",
            "params": [
              {
                "name": "customer_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "last_sync_date",
                "value": "",
                "type": "query",
                "description": " is a Unix Timestamp. If it is set, only users that were created after that timestamp will be returned"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query"
              },
              {
                "name": "pagesize",
                "value": "",
                "type": "query",
                "description": "sets the number of users that should be returned per page <br/>Maximum is 500, default is 100"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "sets the number of pages for the returned users"
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "search keyword based on which users are filtered"
              }
            ]
          },
          "docs": "This API returns all users that were created by a specific customer.\n      Without any extra parameters it will return the first 100 users ordered by ascending ID. Extra parameters can be added to filter and sort the results.<br />\n      <b>Users Sorting:</b>\n      Users can be sorted by their attributes like firstname, company etc. .\n      The sort is always ascending unless the field name is prefixed with a minus (U+002D HYPHEN-MINUS, \"-\") i.e. `-id` or `id`.\n      <br /><b>Example: </b> `/use"
        },
        {
          "info": {
            "name": "Creates user ",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/:customer_id/users",
            "params": [
              {
                "name": "customer_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API is used for creating users. Note: The 'permissions' object with 'defects: true' is required for non-subcontractor and non-watcher users.\n\n**Rate Limit:** 10 requests per minute."
        },
        {
          "info": {
            "name": "Returns a specific user of a customer",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/:customer_id/users/:user_id",
            "params": [
              {
                "name": "customer_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "user_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API returns a specific user that was created by the logged in customer."
        },
        {
          "info": {
            "name": "Updates a specific user of a customer",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/api/v1/:customer_id/users/:user_id",
            "params": [
              {
                "name": "customer_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "user_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API is used for updating a specific user that was created by the logged in customer."
        },
        {
          "info": {
            "name": "Deletes a specific user of a customer ",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/v1/:customer_id/users/:user_id",
            "params": [
              {
                "name": "customer_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "user_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API is used for deleting a specific user that was created by the logged in customer."
        },
        {
          "info": {
            "name": "Downgrades user to subcontractor",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/api/v1/:customer_id/users/downgrade_user_to_subcontractor",
            "params": [
              {
                "name": "customer_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "user_id",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "This API is used for downgrading the type of a  user to subcontractor."
        },
        {
          "info": {
            "name": "Activates deactivated user",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/:customer_id/users/activate_user",
            "params": [
              {
                "name": "customer_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "user_id",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "This API is used for reactivating a specific deactivated user."
        },
        {
          "info": {
            "name": "Exports users as an Excel file",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/:customer_id/users/export_users_xls",
            "params": [
              {
                "name": "customer_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API is used for exporting all users of the logged in customer as an Excel file."
        }
      ]
    }
  ],
  "bundled": true
}