List Distribution Groups
list_distribution_groupsRetrieve a paginated list of distribution groups for a company. Use to find IDs, filter by search, or control pagination with page and per_page parameters.
Instructions
Return a list of all Distribution Groups associated with a Company. 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: company_id. Procore API: Core > Directory. Endpoint: GET /rest/v1.0/companies/{company_id}/distribution_groups
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| company_id | Yes | URL path parameter — unique identifier for the company. | |
| 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. | |
| with_domain_users | No | Query string parameter — return list of user IDs that have permissions to view specified domain. | |
| 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. |