GET /rest/v1.0/projects/{project_id}/distribution_groups

Return a list of all Distribution Groups associated with a Project.

Servers

https://api.procore.com

Path parameters

Name	Type	Required	Description
`project_id`	Integer	Yes	Unique identifier for the project.

Request headers

Name	Type	Required	Description
`Procore-Company-Id`	Integer	Yes	Unique company identifier associated with the Procore User Account.

Query parameters

Name	Type	Required	Description
`page`	Integer	No	Page
`ual`	Integer	No	Parameter affecting the scope for the Distribution Groups. Will return only Distributions Groups who users that have the exact ual specified by the 'ual'. If provided, this will take precendence over min_ual. Only applies to requests that also have include_ancestors set to 'true'.
`per_page`	Integer	No	Elements per page
`sort`	String	No	Return items with the specified sort. Possible values: `"name"`
`min_ual`	Integer	No	Parameter affecting the scope for the Distribution Groups, by default it is the 'read' user access level. Will return only Distributions Groups who users that have the min ual specified by the 'min_ual'. Only applies to requests that also have include_ancestors set to 'true'.
`filterssearch`	String	No	Returns item(s) matching the specified search query string.
`view`	String	No	Parameter affecting what level of detail will be returned from the endpoint. 'extended' will include the users included in each distribution group. Possible values: `"extended"`
`include_ancestors`	Boolean	No	Parameter affecting what groups will be returned from this endpoint. When 'true', this endpoint will only return distribution groups with users that match the provided (or default) `domain_id` and `min_ual` / `ual`. Company level distribution groups will be returned as well if they have users matching the provided (or default) permissions. If `extended` view is requested, only the users with matching permissions will be returned in the response. When `include_ancestors` is false or absent, only Project level groups will be returned.
`domain_id`	Integer	No	Parameter affecting the scope for the Distribution Groups, by default it is the Domain ID of the Submittals Tool. Will return only Distributions Groups who users that have access to the Tool specified by the domain_id. Only applies to requests that also have include_ancestors set to 'true'.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.