Procore.Api.CoreCompanyCompanies (procore_sdk v0.3.0)
API calls for all endpoints tagged CoreCompanyCompanies
.
Summary
Functions
List Companies Return a list of Companies visible to the User. NOTE: This endpoint does not require the ['Procore-Company-Id' header] (https://developers.procore.com/documentation/tutorial-mpz) to be included on a request.
Functions
Link to this function
rest_v10_companies_get(connection, opts \\ [])
@spec rest_v10_companies_get( Tesla.Env.client(), keyword() ) :: {:ok, [Procore.Model.Company.t()]} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
List Companies Return a list of Companies visible to the User. NOTE: This endpoint does not require the ['Procore-Company-Id' header] (https://developers.procore.com/documentation/tutorial-mpz) to be included on a request.
Parameters
connection
(Procore.Connection): Connection to serveropts
(keyword): Optional parameters:page
(integer()): Page:per_page
(integer()): Elements per page:include_free_companies
(boolean()): By default the endpoint excludes free companies. Provide include_free_companies=true to include them
Returns
{:ok, [%Company{}, ...]}
on success{:error, Tesla.Env.t}
on failure