List Project Distribution Groups
list_project_distribution_groups_v1_0Retrieve a paginated list of all distribution groups for a project. Use to find IDs, filter by search, or sort results.
Instructions
Return a list of all Distribution Groups associated with a Project. Use this to enumerate Directory records when you need a paginated overview, to find IDs, or to filter by query parameters. Returns a paginated JSON array of Directory records. Use page and per_page to control pagination; the response includes pagination metadata. Required parameters: project_id. Procore API: Core > Directory. Endpoint: GET /rest/v1.0/projects/{project_id}/distribution_groups
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| project_id | Yes | URL path parameter — unique identifier for the project. | |
| page | No | Query string parameter — page number for paginated results (default: 1) | |
| per_page | No | Query string parameter — number of items per page (default: 100, max: 100) | |
| filters__search | No | Query string parameter — returns item(s) matching the specified search query string. | |
| sort | No | Query string parameter — return items with the specified sort. | |
| view | No | Query string parameter — parameter affecting what level of detail will be returned from the endpoint. 'extended' will include the users included in each distribution group. | |
| include_ancestors | No | Query string parameter — 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 ... | |
| domain_id | No | Query string parameter — 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 specif... | |
| min_ual | No | Query string parameter — 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 | No | Query string parameter — 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 o... |