{
  "opencollection": "1.0.0",
  "info": {
    "name": "Pipedrive API v1 Activities Roles API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Roles",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get all roles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pipedrive.com/v1/roles",
            "params": [
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "Pagination start"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Items shown per page"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Returns all the roles within the company."
        },
        {
          "info": {
            "name": "Add a role",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.pipedrive.com/v1/roles",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Adds a new role."
        },
        {
          "info": {
            "name": "Get one role",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pipedrive.com/v1/roles/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the role"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Returns the details of a specific role."
        },
        {
          "info": {
            "name": "Update role details",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.pipedrive.com/v1/roles/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the role"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Updates the parent role and/or the name of a specific role."
        },
        {
          "info": {
            "name": "Delete a role",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.pipedrive.com/v1/roles/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the role"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Marks a role as deleted."
        },
        {
          "info": {
            "name": "List role assignments",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pipedrive.com/v1/roles/:id/assignments",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the role"
              },
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "Pagination start"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Items shown per page"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Returns all users assigned to a role."
        },
        {
          "info": {
            "name": "Add role assignment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.pipedrive.com/v1/roles/:id/assignments",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the role"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Assigns a user to a role."
        },
        {
          "info": {
            "name": "Delete a role assignment",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.pipedrive.com/v1/roles/:id/assignments",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the role"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Removes the assigned user from a role and adds to the default role."
        },
        {
          "info": {
            "name": "List role settings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pipedrive.com/v1/roles/:id/settings",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the role"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Returns the visibility settings of a specific role."
        },
        {
          "info": {
            "name": "Add or update role setting",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.pipedrive.com/v1/roles/:id/settings",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the role"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Adds or updates the visibility setting for a role."
        },
        {
          "info": {
            "name": "List pipeline visibility for a role",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pipedrive.com/v1/roles/:id/pipelines",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the role"
              },
              {
                "name": "visible",
                "value": "",
                "type": "query",
                "description": "Whether to return the visible or hidden pipelines for the role"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Returns the list of either visible or hidden pipeline IDs for a specific role. For more information on pipeline visibility, please refer to the <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">Visibility groups article</a>."
        },
        {
          "info": {
            "name": "Update pipeline visibility for a role",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.pipedrive.com/v1/roles/:id/pipelines",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the role"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Updates the specified pipelines to be visible and/or hidden for a specific role. For more information on pipeline visibility, please refer to the <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">Visibility groups article</a>."
        }
      ]
    }
  ],
  "bundled": true
}