PermissionSets

Permission sets define what users in the account can do: which actions they are allowed to perform and which features they can access. Permission sets are app-specific, where apps are large parts of functionality, e.g., sales app, which allows accessing sales data, global permissions, which oversee cross-product features (for example contacts, insights, products) or account settings, which provides access to billing, user management, company settings and security center. Some permission sets with types such as admin and regular are pre-created for the account, while other custom ones can be created by users (depending on the tier the account is on).

Get all permission sets

Copy link

Returns data about all permission sets.

API v1
Request
GET

/v1/permissionSets

Query parameters

app

string

The app to filter the permission sets by

Values

sales

projects

campaigns

global

account_settings

Response
200

OK

Expand all
Copy code
    • true
    • [ ... ]

    Get one permission set

    Copy link

    Returns data about a specific permission set.

    API v1
    Request
    GET

    /v1/permissionSets/{id}

    Path parameters

    id

    string

    required

    The ID of the permission set

    Response
    200

    OK

    Expand all
    Copy code
      • true
      • [ ... ]

      List permission set assignments

      Copy link

      Returns the list of assignments for a permission set.

      API v1
      Request
      GET

      /v1/permissionSets/{id}/assignments

      Path parameters

      id

      string

      required

      The ID of the permission set

      Query parameters

      start

      integer

      Pagination start

      Default

      0

      limit

      integer

      Items shown per page

      Response
      200

      OK

      Expand all
      Copy code
        • true
        • [ ... ]

        Subscribe to Pipedrive’s Developer Newsletter