Procore.Api.CoreCompanyDirectoryDistributionGroups (procore_sdk v0.3.0)

API calls for all endpoints tagged CoreCompanyDirectoryDistributionGroups.

Summary

Functions

List Distribution Groups Return a list of all Distribution Groups associated with a Company.

Functions

Link to this function

rest_v10_companies_company_id_distribution_groups_get(connection, procore_company_id, company_id, opts \\ [])

List Distribution Groups Return a list of all Distribution Groups associated with a Company.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • company_id (integer()): Unique identifier for the company.
  • opts (keyword): Optional parameters
    • :page (integer()): Page
    • :per_page (integer()): Elements per page
    • :"filters[search]" (String.t): Returns item(s) matching the specified search query string.
    • :with_domain_users (RestV10CompaniesCompanyIdDistributionGroupsGetWithDomainUsersParameter): Return list of user IDs that have permissions to view specified domain.
    • :sort (String.t): Return items with the specified sort.
    • :view (String.t): Parameter affecting what level of detail will be returned from the endpoint. 'extended' will include the users included in each distribution group.

Returns

  • {:ok, [%RestV10ProjectsProjectIdDistributionGroupsGet200ResponseInner{}, ...]} on success
  • {:error, Tesla.Env.t} on failure