We are introducing pipeline visibility inside the visibility groups feature in our web app and API so users can restrict and control access to specific pipelines and the deals inside them.

What is changing?

When visibility restrictions are applied for a pipeline, the responses of the Pipelines API, Deals API, and Stages API endpoints will behave as following:

1. Pipelines API

The GET endpoints of the Pipelines API will not return information for pipelines that are not visible to the user making the request. This applies to the following endpoints:

• GET /pipelines
• GET /pipelines/{id}
• GET /pipelines/{id}/conversion_statistics
• GET /pipelines/{id}/deals
• GET /pipelines/{id}/movement_statistics

The GET endpoints for retrieving the info of a specific pipeline will return HTTP 404 if the pipeline is not visible.

Deleting a pipeline that is the last visible pipeline for any visibility group will not be possible and a HTTP 400 error response will be returned. This applies to the DELETE /pipelines/{id} endpoint.

2. Deals API

The GET endpoints of the Deals API will not return deal information that is not visible to the user making the request. This applies to the following endpoints:

• GET /deals
• GET /deals/search
• GET /deals/summary
• GET /deals/timeline
• GET /deals/{id}
• GET /deals/{id}/activities
• GET /deals/{id}/files
• GET /deals/{id}/flow
• GET /deals/{id}/followers
• GET /deals/{id}/mailMessages
• GET /deals/{id}/participants
• GET /deals/{id}/persons
• GET /deals/{id}/products

The endpoints for retrieving and updating the information of a specific deal will return HTTP 403 if the deal is not visible.

The POST /deals endpoint will return HTTP 400 in these cases:

• When creating a deal with the pipeline_id or stage_id parameters for a pipeline/stage that is not visible to the user
• When creating a deal with the pipeline_id or stage_id and user_id parameters for a pipeline/stage that is not visible to the assigned user

If a deal is being created without pipeline_id or stage_id assigned, the deal will be automatically assigned to the first pipeline visible to the user.

The PUT /deals/{id} endpoint will return HTTP 403 when supplying a stage_id of a stage that is not visible to the user making the request and/or a user_id who does not have visibility for the pipeline/stage.

3. Stages API

The GET /stages endpoint will not return information about stages which are not visible to the user making the request.

The GET /stages/{id} and GET /stages/{id}/deals endpoints will return HTTP 404 if the specified stage is not visible.

In case of any questions or comments, let us know in the Developer’s Community.