How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Pipedrive Roles API

Roles are a part of the Visibility groups’ feature that allow the admin user to categorize other users and dictate what items they will be allowed access to see.

Pipedrive Roles API is one of 48 APIs that Pipedrive publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Roles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 12 operations across 5 paths. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.pipedrive.com/v1.

12 operations 5 paths 0 schemas 2 DELETE5 GET3 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Server
https://api.pipedrive.com/v1
Authentication
HTTP Basic, API Key, OAuth 2.0
Resource Areas
1

Authentication & Security 3

Pipedrive Roles API declares 3 security schemes for authenticating requests. It accepts HTTP basic authentication (basic_authentication). An API key is passed in the header as x-api-token (api_key). It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 27 scopes.

  • basic_authentication — Base 64 encoded string containing the clientid and clientsecret values. The header value should be Basic .
  • oauth2 — For more information, see https://pipedrive.readme.io/docs/marketplace-oauth-authorization

Paths & Operations 12

Across 5 paths, the API surfaces 12 operations — 2 DELETE, 5 GET, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Roles 12

Roles are a part of the Visibility groups’ feature that allow the admin user to categorize other users and dictate what items they will be allowed access to see.

GET
/roles
Get all roles
getRoles 2 params → 200
POST
/roles
Add a role
addRole body → 200
DELETE
/roles/{id}
Delete a role
deleteRole 1 param → 200
GET
/roles/{id}
Get one role
getRole 1 param → 200
PUT
/roles/{id}
Update role details
updateRole 1 param body → 200
DELETE
/roles/{id}/assignments
Delete a role assignment
deleteRoleAssignment 1 param body → 200
GET
/roles/{id}/assignments
List role assignments
getRoleAssignments 3 params → 200
POST
/roles/{id}/assignments
Add role assignment
addRoleAssignment 1 param body → 200
GET
/roles/{id}/settings
List role settings
getRoleSettings 1 param → 200
POST
/roles/{id}/settings
Add or update role setting
addOrUpdateRoleSetting 1 param body → 200
GET
/roles/{id}/pipelines
List pipeline visibility for a role
getRolePipelines 2 params → 200
PUT
/roles/{id}/pipelines
Update pipeline visibility for a role
updateRolePipelines 1 param body → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pipedrive-roles-api-openapi.yml Raw ↑

Other APIs Pipedrive publishes across the network.

Pipedrive Activities API
Pipedrive ActivityFields API
Pipedrive ActivityTypes API
Pipedrive Beta API
Pipedrive Billing API
Pipedrive CallLogs API
Pipedrive Channels API
Pipedrive Currencies API
Pipedrive DealFields API
Pipedrive DealInstallments API
Pipedrive DealProducts API
Pipedrive Deals API
Where this information came from

This is an independent, third-party profile of Pipedrive Roles API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.