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

Show detail on a specified Project Distribution Group

Servers

Path parameters

Name Type Required Description
project_id Integer Yes

Unique identifier for the project.

distribution_group_id Integer Yes

Unique identifier for the distribution group.

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
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'.

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'.

view String No

Parameter affecting what level of detail will be returned from the endpoint. 'extended' will include the users in the distribution group.

Possible values:

  • "extended"
include_ancestors Boolean No

Parameter affecting what groups can 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 can be viewed 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 can be viewed.

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

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.