{
  "opencollection": "1.0.0",
  "info": {
    "name": "PlanRadar's API Documentation Approval Requests V2 Projects API",
    "version": "2.0"
  },
  "items": [
    {
      "info": {
        "name": "Projects",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get all project memberships",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/:customer_id/projects/:project_id/memberships",
            "params": [
              {
                "name": "customer_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "use 0 to return all project memberships"
              },
              {
                "name": "last_sync_date",
                "value": "",
                "type": "query",
                "description": "Unix timestamp in seconds. When provided, returns only memberships changed after this time (incremental sync). Omit or use 0 to return all memberships. Non-numeric values are ignored."
              }
            ]
          },
          "docs": "Get all users that are member of a specific project"
        },
        {
          "info": {
            "name": "Returns all groups of a specific project",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/:customer_id/projects/:project_id/project_groups",
            "params": [
              {
                "name": "customer_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "project_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "sets the number of pages for the returned groups"
              },
              {
                "name": "pagesize",
                "value": "",
                "type": "query",
                "description": "sets the number of groups that should be returned per page <br/>Maximum is 500, default is 100"
              },
              {
                "name": "check_inhouse",
                "value": "",
                "type": "query",
                "description": "sets whether or not the returned groups should contain an in house user type"
              }
            ]
          },
          "docs": "This API returns all groups of a specific project based on its id. Without any extra parameters it will return the first 100 groups ordered by ascending ID. Extra parameters can be added to sort the results.<br /> <b>Group Sorting:</b> Groups can be sorted by the amount of users they have. <br /><b>Example: </b> `/project_groups?sort=count`<br /> Moreover, they can be sorted by the groups's name: group.name, the leader's first name: leader.firstname or the leader's email: leader.mail. The sort i"
        },
        {
          "info": {
            "name": "Returns all users of a project",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/:customer_id/projects/:project_id/users",
            "params": [
              {
                "name": "customer_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "set project id to 0 if you want to get all the users that are part of projects"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "sets the number of pages for the returned users"
              },
              {
                "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": "sort",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "This API returns all users of a specific project including customer permissions and groups.<br /> Without any extra parameters it will return the first 100 users ordered by ascending ID. Extra parameters can be added to sort the results.<br /> <b>User Sorting:</b> Users can be sorted by their attributes e.g id, firstname, lastname, company. Moreover, the results can be sorted by other characteristics such as customer_permissions and project_memberships. The sort is always ascending unless the fi"
        },
        {
          "info": {
            "name": "Adds specific user/s to project",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/:customer_id/projects/:project_id/add_member_to_project",
            "params": [
              {
                "name": "customer_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "project_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API is used for assigning a specific user to a specific project."
        },
        {
          "info": {
            "name": "Removes specific member from project",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/:customer_id/projects/:project_id/remove_member_from_project",
            "params": [
              {
                "name": "customer_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "project_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API is used for removing a specific user from a specific project."
        },
        {
          "info": {
            "name": "Adds specific group/s to project",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/:customer_id/projects/:project_id/add_group_to_project",
            "params": [
              {
                "name": "customer_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "project_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API is used for adding one group or multiple groups with a specific role to a specific project based on its id. "
        },
        {
          "info": {
            "name": "Updates specific member role of project",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/api/v1/:customer_id/projects/:project_id/update_project_member_role",
            "params": [
              {
                "name": "customer_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "project_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API is used for updating the role of a specific member of a specific project"
        },
        {
          "info": {
            "name": "Returns all projects",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/:customer_id/projects",
            "params": [
              {
                "name": "customer_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query"
              },
              {
                "name": "pagesize",
                "value": "",
                "type": "query",
                "description": "sets the number of projects 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 projects"
              }
            ]
          },
          "docs": "This API returns all projects of the logged in customer. Without any extra parameters it will return the first 100 projects ordered by ascending ID. Extra parameters can be added to sort the results. <br ><b>Project Sorting: </b> <br /> Projects can be sorted by the project's id: running_number, project's name: name, project's code: projectnumber, project's start date: drstart_date, project's end date: drend_date, project's zipcode: zipcode, project's city: city, project's street: street, projec"
        },
        {
          "info": {
            "name": "Creates project",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/:customer_id/projects",
            "params": [
              {
                "name": "customer_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API is used for creating a new project."
        },
        {
          "info": {
            "name": "Copies specific project ",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/:customer_id/projects/:project_id/copy_project",
            "params": [
              {
                "name": "customer_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "project_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "sets the name of the copy of the project"
              },
              {
                "name": "details",
                "value": "",
                "type": "query",
                "description": "sets whether or not the copy of the project should contain the project's details"
              },
              {
                "name": "groups",
                "value": "",
                "type": "query",
                "description": "sets whether or not the copy of the project should contain the project's groups"
              },
              {
                "name": "ticket_types",
                "value": "",
                "type": "query",
                "description": "sets whether or not the copy of the project should contain the project's forms and lists"
              },
              {
                "name": "users",
                "value": "",
                "type": "query",
                "description": "sets whether or not the copy of the project should contain the project's users"
              },
              {
                "name": "components",
                "value": "",
                "type": "query",
                "description": "sets whether or not the copy of the project should contain the project's layers and plans"
              }
            ]
          },
          "docs": "This API is used for copying a specific project based on its id."
        },
        {
          "info": {
            "name": "Exports data of a specific project",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/:customer_id/projects/:project_id/export_project",
            "params": [
              {
                "name": "customer_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "project_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "filter_id",
                "value": "",
                "type": "query",
                "description": "id of the filter of the tickets that should be exported with the project "
              },
              {
                "name": "timezone_offset",
                "value": "",
                "type": "query",
                "description": "is a timestamp - is the difference between the local time and the worlwide UTC time"
              },
              {
                "name": "includedocuments",
                "value": "",
                "type": "query",
                "description": "sets whether or not all documents should be included in the export"
              }
            ]
          },
          "docs": "This API is used for exporting the data of a specific project based on its id."
        },
        {
          "info": {
            "name": "Returns specific project",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/:customer_id/projects/:project_id",
            "params": [
              {
                "name": "customer_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "project_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API returns a specific project based on its id."
        },
        {
          "info": {
            "name": "Updates specific project",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/api/v1/:customer_id/projects/:project_id",
            "params": [
              {
                "name": "customer_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "project_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API is used for updating a specific project based on its id."
        },
        {
          "info": {
            "name": "Archives/Unarchives specific project",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/api/v1/:customer_id/projects/:project_id/archive_project",
            "params": [
              {
                "name": "customer_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "project_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API is used for archiving/unarchiving a specific project based on its id."
        },
        {
          "info": {
            "name": "Removes a group from a specific project",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/:customer_id/projects/:project_id/remove_group_from_project",
            "params": [
              {
                "name": "customer_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "project_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API is used for removing a specific group from a specific project."
        },
        {
          "info": {
            "name": "Updates project's group role",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/:customer_id/projects/:project_id/update_project_group_role",
            "params": [
              {
                "name": "customer_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "project_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API is used for updating the role of a specific group that is assigned to a specific project."
        }
      ]
    }
  ],
  "bundled": true
}