GET /rest/v1.0/companies/{company_id}/distribution_groups
Return a list of all Distribution Groups associated with a Company.
Servers
- https://api.procore.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
company_id |
Integer | Yes |
Unique identifier for the company. |
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 |
per_page |
Integer | No |
Elements per page |
sort |
String | No |
Return items with the specified sort. Possible values:
|
with_domain_users |
Object | No |
Return list of user IDs that have permissions to view specified domain. |
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:
|
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.