Procore.Api.CoreCompanyRoles (procore_sdk v0.3.0)

API calls for all endpoints tagged CoreCompanyRoles.

Summary

Functions

Link to this function

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

@spec rest_v10_companies_company_id_roles_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, [Procore.Model.Role.t()]}
  | {:error, Tesla.Env.t()}

List Company Roles Return a list of roles for 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
    • :"filters[users_only]" (boolean()): If true, returns only project roles of type user.

Returns

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