Procore.Api.CoreCompanyDirectoryCompanyUsers (procore_sdk v0.3.0)

API calls for all endpoints tagged CoreCompanyDirectoryCompanyUsers.

Summary

Functions

Show current company user Show detail on the current Company User.

List company users Return a list of all active users associated with a company. To retrieve a list of inactive users, see List Company Inactive Users. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.

Update company user Update the specified User. #### Uploading avatar To upload avatar you must upload whole payload as multipart/form-data content-type and specify each parameter as form-data together with user[avatar] as file. #### Country and State codes The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification. See Working with Country Codes for additional information.

Create company user Create a new User in the specified Company. #### Uploading avatar To upload avatar you must upload whole payload as multipart/form-data content-type and specify each parameter as form-data together with user[avatar] as file. #### Country and State codes The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification. See Working with Country Codes for additional information.

Sync company users This endpoint creates or updates a batch of Company Users. See Using Sync Actions for additional information. Requires Directory Admin permissions. #### Country and State codes The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification. See Working with Country Codes for additional information.

List company users Return a list of all Users associated with a Company. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.

Create company user Create a new User in the specified Company. #### Uploading avatar To upload avatar you must upload whole payload as multipart/form-data content-type and specify each parameter as form-data together with user[avatar] as file. #### Country and State codes The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification. See Working with Country Codes for additional information.

Show current company user Show detail on the current Company User.

Bulk add company users to projects This endpoint allows company users to be bulk added to multiple projects with a permission template in one request. If the user was already part of that project it will not update the assigned permission template.

Bulk remove company users from projects This endpoint allows company users to be bulk removed from multiple projects.

List company users Return a list of all active users associated with a company. To retrieve a list of inactive users, see List Company Inactive Users. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.

Update company user Update the specified User. #### Uploading avatar To upload avatar you must upload whole payload as multipart/form-data content-type and specify each parameter as form-data together with user[avatar] as file. #### Country and State codes The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification. See Working with Country Codes for additional information.

Create company user Create a new User in the specified Company. #### Uploading avatar To upload avatar you must upload whole payload as multipart/form-data content-type and specify each parameter as form-data together with user[avatar] as file. #### Country and State codes The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification. See Working with Country Codes for additional information.

Sync company users This endpoint creates or updates a batch of Company Users. See Using Sync Actions for additional information. Requires Directory Admin permissions. #### Country and State codes The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification. See Working with Country Codes for additional information.

List company users Return a list of all Users associated with a Company. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.

Show current company user Show detail on the current Company User.

Bulk add company users to projects This endpoint allows company users to be bulk added to multiple projects with a permission template in one request. If the user was already part of that project it will not update the assigned permission template.

Bulk remove company users from projects This endpoint allows company users to be bulk removed from multiple projects.

List company users Return a list of all active users associated with a company. To retrieve a list of inactive users, see List Company Inactive Users. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.

Update company user Update the specified User. #### Uploading avatar To upload avatar you must upload whole payload as multipart/form-data content-type and specify each parameter as form-data together with user[avatar] as file. #### Country and State codes The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification. See Working with Country Codes for additional information.

Create company user Create a new User in the specified Company. #### Uploading avatar To upload avatar you must upload whole payload as multipart/form-data content-type and specify each parameter as form-data together with user[avatar] as file. #### Country and State codes The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification. See Working with Country Codes for additional information.

Sync company users This endpoint creates or updates a batch of Company Users. See Using Sync Actions for additional information. Requires Directory Admin permissions. #### Country and State codes The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification. See Working with Country Codes for additional information.

List company users Return a list of all Users associated with a Company. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.

Show current company user Show detail on the current Company User.

Bulk add company users to projects This endpoint allows company users to be bulk added to multiple projects with a permission template in one request. If the user was already part of that project it will not update the assigned permission template.

Bulk remove company users from projects This endpoint allows company users to be bulk removed from multiple projects.

List company users Return a list of all active users associated with a company. To retrieve a list of inactive users, see List Company Inactive Users. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.

Update company user Update the specified User. #### Uploading avatar To upload avatar you must upload whole payload as multipart/form-data content-type and specify each parameter as form-data together with user[avatar] as file. #### Country and State codes The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification. See Working with Country Codes for additional information.

Create company user Create a new User in the specified Company. #### Uploading avatar To upload avatar you must upload whole payload as multipart/form-data content-type and specify each parameter as form-data together with user[avatar] as file. #### Country and State codes The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification. See Working with Country Codes for additional information.

Sync company users This endpoint creates or updates a batch of Company Users. See Using Sync Actions for additional information. Requires Directory Admin permissions. #### Country and State codes The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification. See Working with Country Codes for additional information.

List company users Return a list of all Users associated with a Company. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.

Bulk remove project details for company users on projects This endpoint allows company users to bulk remove project details on multiple projects

Bulk update project details for company users on projects This endpoint allows company users to bulk update their project details on multiple projects

Functions

Link to this function

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

@spec rest_v10_companies_company_id_me_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, Procore.Model.NormalView2.t()}
  | {:error, Tesla.Env.t()}

Show current company user Show detail on the current Company User.

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

Returns

  • {:ok, Procore.Model.NormalView2.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

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

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

List company users Return a list of all active users associated with a company. To retrieve a list of inactive users, see List Company Inactive Users. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.

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[created_at]" (Date.t): Return item(s) created within the specified ISO 8601 datetime range. Formats: YYYY-MM-DD...YYYY-MM-DD - Date YYYY-MM-DDTHH:MM:SSZ...YYYY-MM-DDTHH:MM:SSZ - DateTime with UTC Offset YYYY-MM-DDTHH:MM:SS+XX:00...YYYY-MM-DDTHH:MM:SS+XX:00- Datetime with Custom Offset -:"filters[updated_at]"(Date.t): Return item(s) last updated within the specified ISO 8601 datetime range. Formats:YYYY-MM-DD...YYYY-MM-DD- DateYYYY-MM-DDTHH:MM:SSZ...YYYY-MM-DDTHH:MM:SSZ- DateTime with UTC OffsetYYYY-MM-DDTHH:MM:SS+XX:00...YYYY-MM-DDTHH:MM:SS+XX:00- Datetime with Custom Offset -:"filters[vendor_id]"([integer()]): Return item(s) with the specified Vendor IDs. -:"filters[origin_id]"(String.t): Origin ID. Returns item(s) with the specified Origin ID. -:"filters[trade_id][]"([integer()]): Returns users whose vendor record is associated with the specified trade id(s). -:"filters[search]"(String.t): Return users where the search string matches the user's first name, last name, email address, keywords, job title, or company name -:sort(String.t): Return items with the specified sort. ### Returns -, ...]}on success -` on failure
Link to this function

rest_v10_companies_company_id_users_id_get(connection, procore_company_id, company_id, id, opts \\ [])

@spec rest_v10_companies_company_id_users_id_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, Procore.Model.CompanyUser2.t()}
  | {:error, Tesla.Env.t()}

Show company user Show detail on a specified User.

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.
  • id (integer()): ID of the user
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.CompanyUser2.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_companies_company_id_users_id_invite_patch(connection, procore_company_id, company_id, id, opts \\ [])

@spec rest_v10_companies_company_id_users_id_invite_patch(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok, map()}
  | {:ok,
     Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:error, Tesla.Env.t()}

Send invite Send invite email to specified user.

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.
  • id (integer()): ID of the user
  • opts (keyword): Optional parameters

Returns

  • {:ok, map()} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_companies_company_id_users_id_patch(connection, procore_company_id, company_id, id, user, opts \\ [])

Update company user Update the specified User. #### Uploading avatar To upload avatar you must upload whole payload as multipart/form-data content-type and specify each parameter as form-data together with user[avatar] as file. #### Country and State codes The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification. See Working with Country Codes for additional information.

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.
  • id (integer()): ID of the user
  • user (Procore.Model.CompanyUser3.t):
  • opts (keyword): Optional parameters
    • :run_configurable_validations (boolean()): If true, validations are run for the corresponding Configurable Field Set.

Returns

  • {:ok, Procore.Model.NormalView2.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_companies_company_id_users_post(connection, procore_company_id, company_id, company_user_body3, opts \\ [])

Create company user Create a new User in the specified Company. #### Uploading avatar To upload avatar you must upload whole payload as multipart/form-data content-type and specify each parameter as form-data together with user[avatar] as file. #### Country and State codes The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification. See Working with Country Codes for additional information.

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.
  • company_user_body3 (CompanyUserBody3):
  • opts (keyword): Optional parameters
    • :run_configurable_validations (boolean()): If true, validations are run for the corresponding Configurable Field Set.

Returns

  • {:ok, Procore.Model.NormalView2.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_companies_company_id_users_sync_patch(connection, procore_company_id, company_id, updates, opts \\ [])

Sync company users This endpoint creates or updates a batch of Company Users. See Using Sync Actions for additional information. Requires Directory Admin permissions. #### Country and State codes The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification. See Working with Country Codes for additional information.

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.
  • updates ([Procore.Model.CompanyUsersInner.t]):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.RestV13CompaniesCompanyIdUsersSyncPatch200Response.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

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

List company users Return a list of all Users associated with a Company. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.

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[active]" (boolean()): If true, returns item(s) with a status of 'active'.
    • :"filters[created_at]" (Date.t): Return item(s) created within the specified ISO 8601 datetime range. Formats: YYYY-MM-DD...YYYY-MM-DD - Date YYYY-MM-DDTHH:MM:SSZ...YYYY-MM-DDTHH:MM:SSZ - DateTime with UTC Offset YYYY-MM-DDTHH:MM:SS+XX:00...YYYY-MM-DDTHH:MM:SS+XX:00- Datetime with Custom Offset -:"filters[updated_at]"(Date.t): Return item(s) last updated within the specified ISO 8601 datetime range. Formats:YYYY-MM-DD...YYYY-MM-DD- DateYYYY-MM-DDTHH:MM:SSZ...YYYY-MM-DDTHH:MM:SSZ- DateTime with UTC OffsetYYYY-MM-DDTHH:MM:SS+XX:00...YYYY-MM-DDTHH:MM:SS+XX:00- Datetime with Custom Offset -:"filters[vendor_id]"([integer()]): Return item(s) with the specified Vendor IDs. -:"filters[origin_id]"(String.t): Origin ID. Returns item(s) with the specified Origin ID. -:"filters[trade_id][]"([integer()]): Returns users whose vendor record is associated with the specified trade id(s). -:"filters[search]"(String.t): Return users where the search string matches the user's first name, last name, email address, keywords, job title, or company name -:sort(String.t): Return items with the specified sort. ### Returns -, ...]}on success -` on failure
Link to this function

rest_v10_users_id_get(connection, procore_company_id, company_id, id, opts \\ [])

Show company user Show detail on a specified User.

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.
  • id (integer()): ID of the user
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.CompanyUser2.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_users_post(connection, procore_company_id, company_id, company_user_body3, opts \\ [])

Create company user Create a new User in the specified Company. #### Uploading avatar To upload avatar you must upload whole payload as multipart/form-data content-type and specify each parameter as form-data together with user[avatar] as file. #### Country and State codes The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification. See Working with Country Codes for additional information.

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.
  • company_user_body3 (CompanyUserBody3):
  • opts (keyword): Optional parameters
    • :run_configurable_validations (boolean()): If true, validations are run for the corresponding Configurable Field Set.

Returns

  • {:ok, Procore.Model.CompanyUser5.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

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

@spec rest_v11_companies_company_id_me_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, Procore.Model.CompanyUser4.t()}
  | {:error, Tesla.Env.t()}

Show current company user Show detail on the current Company User.

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

Returns

  • {:ok, Procore.Model.CompanyUser4.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v11_companies_company_id_users_bulk_add_post(connection, procore_company_id, company_id, company_user_body_bulk_add, opts \\ [])

Bulk add company users to projects This endpoint allows company users to be bulk added to multiple projects with a permission template in one request. If the user was already part of that project it will not update the assigned permission template.

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.
  • company_user_body_bulk_add (CompanyUserBodyBulkAdd):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.RestV13CompaniesCompanyIdUsersBulkRemovePost200Response.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v11_companies_company_id_users_bulk_remove_post(connection, procore_company_id, company_id, company_user_body_bulk_remove, opts \\ [])

Bulk remove company users from projects This endpoint allows company users to be bulk removed from multiple projects.

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.
  • company_user_body_bulk_remove (CompanyUserBodyBulkRemove):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.RestV13CompaniesCompanyIdUsersBulkRemovePost200Response.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

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

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

List company users Return a list of all active users associated with a company. To retrieve a list of inactive users, see List Company Inactive Users. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.

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[created_at]" (Date.t): Return item(s) created within the specified ISO 8601 datetime range. Formats: YYYY-MM-DD...YYYY-MM-DD - Date YYYY-MM-DDTHH:MM:SSZ...YYYY-MM-DDTHH:MM:SSZ - DateTime with UTC Offset YYYY-MM-DDTHH:MM:SS+XX:00...YYYY-MM-DDTHH:MM:SS+XX:00- Datetime with Custom Offset -:"filters[updated_at]"(Date.t): Return item(s) last updated within the specified ISO 8601 datetime range. Formats:YYYY-MM-DD...YYYY-MM-DD- DateYYYY-MM-DDTHH:MM:SSZ...YYYY-MM-DDTHH:MM:SSZ- DateTime with UTC OffsetYYYY-MM-DDTHH:MM:SS+XX:00...YYYY-MM-DDTHH:MM:SS+XX:00- Datetime with Custom Offset -:"filters[vendor_id]"([integer()]): Return item(s) with the specified Vendor IDs. -:"filters[origin_id]"(String.t): Origin ID. Returns item(s) with the specified Origin ID. -:"filters[trade_id][]"([integer()]): Returns users whose vendor record is associated with the specified trade id(s). -:"filters[search]"(String.t): Return users where the search string matches the user's first name, last name, email address, keywords, job title, or company name -:sort(String.t): Return items with the specified sort. ### Returns -, ...]}on success -` on failure
Link to this function

rest_v11_companies_company_id_users_id_get(connection, procore_company_id, company_id, id, opts \\ [])

@spec rest_v11_companies_company_id_users_id_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, Procore.Model.CompanyUser2.t()}
  | {:error, Tesla.Env.t()}

Show company user Show detail on a specified User.

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.
  • id (integer()): ID of the user
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.CompanyUser2.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v11_companies_company_id_users_id_invite_patch(connection, procore_company_id, company_id, id, opts \\ [])

@spec rest_v11_companies_company_id_users_id_invite_patch(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok, map()}
  | {:ok,
     Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:error, Tesla.Env.t()}

Send invite Send invite email to specified user.

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.
  • id (integer()): ID of the user
  • opts (keyword): Optional parameters

Returns

  • {:ok, map()} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v11_companies_company_id_users_id_patch(connection, procore_company_id, company_id, id, user, opts \\ [])

Update company user Update the specified User. #### Uploading avatar To upload avatar you must upload whole payload as multipart/form-data content-type and specify each parameter as form-data together with user[avatar] as file. #### Country and State codes The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification. See Working with Country Codes for additional information.

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.
  • id (integer()): ID of the user
  • user (Procore.Model.CompanyUser3.t):
  • opts (keyword): Optional parameters
    • :run_configurable_validations (boolean()): If true, validations are run for the corresponding Configurable Field Set.

Returns

  • {:ok, Procore.Model.NormalView2.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v11_companies_company_id_users_post(connection, procore_company_id, company_id, company_user_body3, opts \\ [])

Create company user Create a new User in the specified Company. #### Uploading avatar To upload avatar you must upload whole payload as multipart/form-data content-type and specify each parameter as form-data together with user[avatar] as file. #### Country and State codes The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification. See Working with Country Codes for additional information.

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.
  • company_user_body3 (CompanyUserBody3):
  • opts (keyword): Optional parameters
    • :run_configurable_validations (boolean()): If true, validations are run for the corresponding Configurable Field Set.

Returns

  • {:ok, Procore.Model.NormalView2.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v11_companies_company_id_users_sync_patch(connection, procore_company_id, company_id, updates, opts \\ [])

Sync company users This endpoint creates or updates a batch of Company Users. See Using Sync Actions for additional information. Requires Directory Admin permissions. #### Country and State codes The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification. See Working with Country Codes for additional information.

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.
  • updates ([Procore.Model.CompanyUsersInner.t]):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.RestV13CompaniesCompanyIdUsersSyncPatch200Response.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

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

List company users Return a list of all Users associated with a Company. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.

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[active]" (boolean()): If true, returns item(s) with a status of 'active'.
    • :"filters[created_at]" (Date.t): Return item(s) created within the specified ISO 8601 datetime range. Formats: YYYY-MM-DD...YYYY-MM-DD - Date YYYY-MM-DDTHH:MM:SSZ...YYYY-MM-DDTHH:MM:SSZ - DateTime with UTC Offset YYYY-MM-DDTHH:MM:SS+XX:00...YYYY-MM-DDTHH:MM:SS+XX:00- Datetime with Custom Offset -:"filters[updated_at]"(Date.t): Return item(s) last updated within the specified ISO 8601 datetime range. Formats:YYYY-MM-DD...YYYY-MM-DD- DateYYYY-MM-DDTHH:MM:SSZ...YYYY-MM-DDTHH:MM:SSZ- DateTime with UTC OffsetYYYY-MM-DDTHH:MM:SS+XX:00...YYYY-MM-DDTHH:MM:SS+XX:00- Datetime with Custom Offset -:"filters[vendor_id]"([integer()]): Return item(s) with the specified Vendor IDs. -:"filters[origin_id]"(String.t): Origin ID. Returns item(s) with the specified Origin ID. -:"filters[trade_id][]"([integer()]): Returns users whose vendor record is associated with the specified trade id(s). -:"filters[search]"(String.t): Return users where the search string matches the user's first name, last name, email address, keywords, job title, or company name -:sort(String.t): Return items with the specified sort. ### Returns -, ...]}on success -` on failure
Link to this function

rest_v11_users_id_get(connection, procore_company_id, company_id, id, opts \\ [])

Show company user Show detail on a specified User.

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.
  • id (integer()): ID of the user
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.CompanyUser2.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

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

@spec rest_v12_companies_company_id_me_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, Procore.Model.CompanyUser4.t()}
  | {:error, Tesla.Env.t()}

Show current company user Show detail on the current Company User.

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

Returns

  • {:ok, Procore.Model.CompanyUser4.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v12_companies_company_id_users_bulk_add_post(connection, procore_company_id, company_id, company_user_body_bulk_add, opts \\ [])

Bulk add company users to projects This endpoint allows company users to be bulk added to multiple projects with a permission template in one request. If the user was already part of that project it will not update the assigned permission template.

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.
  • company_user_body_bulk_add (CompanyUserBodyBulkAdd):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.RestV13CompaniesCompanyIdUsersBulkRemovePost200Response.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v12_companies_company_id_users_bulk_remove_post(connection, procore_company_id, company_id, company_user_body_bulk_remove, opts \\ [])

Bulk remove company users from projects This endpoint allows company users to be bulk removed from multiple projects.

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.
  • company_user_body_bulk_remove (CompanyUserBodyBulkRemove):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.RestV13CompaniesCompanyIdUsersBulkRemovePost200Response.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

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

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

List company users Return a list of all active users associated with a company. To retrieve a list of inactive users, see List Company Inactive Users. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.

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[created_at]" (Date.t): Return item(s) created within the specified ISO 8601 datetime range. Formats: YYYY-MM-DD...YYYY-MM-DD - Date YYYY-MM-DDTHH:MM:SSZ...YYYY-MM-DDTHH:MM:SSZ - DateTime with UTC Offset YYYY-MM-DDTHH:MM:SS+XX:00...YYYY-MM-DDTHH:MM:SS+XX:00- Datetime with Custom Offset -:"filters[updated_at]"(Date.t): Return item(s) last updated within the specified ISO 8601 datetime range. Formats:YYYY-MM-DD...YYYY-MM-DD- DateYYYY-MM-DDTHH:MM:SSZ...YYYY-MM-DDTHH:MM:SSZ- DateTime with UTC OffsetYYYY-MM-DDTHH:MM:SS+XX:00...YYYY-MM-DDTHH:MM:SS+XX:00- Datetime with Custom Offset -:"filters[vendor_id]"([integer()]): Return item(s) with the specified Vendor IDs. -:"filters[origin_id]"(String.t): Origin ID. Returns item(s) with the specified Origin ID. -:"filters[trade_id][]"([integer()]): Returns users whose vendor record is associated with the specified trade id(s). -:"filters[search]"(String.t): Return users where the search string matches the user's first name, last name, email address, keywords, job title, or company name -:sort(String.t): Return items with the specified sort. ### Returns -, ...]}on success -` on failure
Link to this function

rest_v12_companies_company_id_users_id_get(connection, procore_company_id, company_id, id, opts \\ [])

@spec rest_v12_companies_company_id_users_id_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, Procore.Model.CompanyUser2.t()}
  | {:error, Tesla.Env.t()}

Show company user Show detail on a specified User.

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.
  • id (integer()): ID of the user
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.CompanyUser2.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v12_companies_company_id_users_id_invite_patch(connection, procore_company_id, company_id, id, opts \\ [])

@spec rest_v12_companies_company_id_users_id_invite_patch(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok, map()}
  | {:ok,
     Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:error, Tesla.Env.t()}

Send invite Send invite email to specified user.

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.
  • id (integer()): ID of the user
  • opts (keyword): Optional parameters

Returns

  • {:ok, map()} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v12_companies_company_id_users_id_patch(connection, procore_company_id, company_id, id, user, opts \\ [])

Update company user Update the specified User. #### Uploading avatar To upload avatar you must upload whole payload as multipart/form-data content-type and specify each parameter as form-data together with user[avatar] as file. #### Country and State codes The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification. See Working with Country Codes for additional information.

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.
  • id (integer()): ID of the user
  • user (Procore.Model.CompanyUser3.t):
  • opts (keyword): Optional parameters
    • :run_configurable_validations (boolean()): If true, validations are run for the corresponding Configurable Field Set.

Returns

  • {:ok, Procore.Model.NormalView2.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v12_companies_company_id_users_post(connection, procore_company_id, company_id, company_user_body3, opts \\ [])

Create company user Create a new User in the specified Company. #### Uploading avatar To upload avatar you must upload whole payload as multipart/form-data content-type and specify each parameter as form-data together with user[avatar] as file. #### Country and State codes The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification. See Working with Country Codes for additional information.

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.
  • company_user_body3 (CompanyUserBody3):
  • opts (keyword): Optional parameters
    • :run_configurable_validations (boolean()): If true, validations are run for the corresponding Configurable Field Set.

Returns

  • {:ok, Procore.Model.NormalView2.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v12_companies_company_id_users_sync_patch(connection, procore_company_id, company_id, updates, opts \\ [])

Sync company users This endpoint creates or updates a batch of Company Users. See Using Sync Actions for additional information. Requires Directory Admin permissions. #### Country and State codes The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification. See Working with Country Codes for additional information.

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.
  • updates ([Procore.Model.CompanyUsersInner.t]):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.RestV13CompaniesCompanyIdUsersSyncPatch200Response.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

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

List company users Return a list of all Users associated with a Company. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.

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[active]" (boolean()): If true, returns item(s) with a status of 'active'.
    • :"filters[created_at]" (Date.t): Return item(s) created within the specified ISO 8601 datetime range. Formats: YYYY-MM-DD...YYYY-MM-DD - Date YYYY-MM-DDTHH:MM:SSZ...YYYY-MM-DDTHH:MM:SSZ - DateTime with UTC Offset YYYY-MM-DDTHH:MM:SS+XX:00...YYYY-MM-DDTHH:MM:SS+XX:00- Datetime with Custom Offset -:"filters[updated_at]"(Date.t): Return item(s) last updated within the specified ISO 8601 datetime range. Formats:YYYY-MM-DD...YYYY-MM-DD- DateYYYY-MM-DDTHH:MM:SSZ...YYYY-MM-DDTHH:MM:SSZ- DateTime with UTC OffsetYYYY-MM-DDTHH:MM:SS+XX:00...YYYY-MM-DDTHH:MM:SS+XX:00- Datetime with Custom Offset -:"filters[vendor_id]"([integer()]): Return item(s) with the specified Vendor IDs. -:"filters[origin_id]"(String.t): Origin ID. Returns item(s) with the specified Origin ID. -:"filters[trade_id][]"([integer()]): Returns users whose vendor record is associated with the specified trade id(s). -:"filters[search]"(String.t): Return users where the search string matches the user's first name, last name, email address, keywords, job title, or company name -:sort(String.t): Return items with the specified sort. ### Returns -, ...]}on success -` on failure
Link to this function

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

@spec rest_v13_companies_company_id_me_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, Procore.Model.CompanyUser4.t()}
  | {:error, Tesla.Env.t()}

Show current company user Show detail on the current Company User.

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

Returns

  • {:ok, Procore.Model.CompanyUser4.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v13_companies_company_id_users_bulk_add_post(connection, procore_company_id, company_id, company_user_body_bulk_add, opts \\ [])

Bulk add company users to projects This endpoint allows company users to be bulk added to multiple projects with a permission template in one request. If the user was already part of that project it will not update the assigned permission template.

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.
  • company_user_body_bulk_add (CompanyUserBodyBulkAdd):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.RestV13CompaniesCompanyIdUsersBulkAddPost200Response.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v13_companies_company_id_users_bulk_remove_post(connection, procore_company_id, company_id, company_user_body_bulk_remove, opts \\ [])

Bulk remove company users from projects This endpoint allows company users to be bulk removed from multiple projects.

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.
  • company_user_body_bulk_remove (CompanyUserBodyBulkRemove):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.RestV13CompaniesCompanyIdUsersBulkRemovePost200Response.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

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

List company users Return a list of all active users associated with a company. To retrieve a list of inactive users, see List Company Inactive Users. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.

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
    • :view (String.t): Specifies which view of the resource to return (which attributes should be present in the response). If a valid view is not provided, it will return the default view: normal.
    • :page (integer()): Page
    • :per_page (integer()): Elements per page
    • :"filters[created_at]" (Date.t): Return item(s) created within the specified ISO 8601 datetime range. Formats: YYYY-MM-DD...YYYY-MM-DD - Date YYYY-MM-DDTHH:MM:SSZ...YYYY-MM-DDTHH:MM:SSZ - DateTime with UTC Offset YYYY-MM-DDTHH:MM:SS+XX:00...YYYY-MM-DDTHH:MM:SS+XX:00- Datetime with Custom Offset -:"filters[updated_at]"(Date.t): Return item(s) last updated within the specified ISO 8601 datetime range. Formats:YYYY-MM-DD...YYYY-MM-DD- DateYYYY-MM-DDTHH:MM:SSZ...YYYY-MM-DDTHH:MM:SSZ- DateTime with UTC OffsetYYYY-MM-DDTHH:MM:SS+XX:00...YYYY-MM-DDTHH:MM:SS+XX:00- Datetime with Custom Offset -:"filters[vendor_id]"([integer()]): Return item(s) with the specified Vendor IDs. -:"filters[origin_id]"(String.t): Origin ID. Returns item(s) with the specified Origin ID. -:"filters[trade_id][]"([integer()]): Returns users whose vendor record is associated with the specified trade id(s). -:"filters[search]"(String.t): Return users where the search string matches the user's first name, last name, email address, keywords, job title, or company name -:sort(String.t): Return items with the specified sort. ### Returns -, ...]}on success -` on failure
Link to this function

rest_v13_companies_company_id_users_id_get(connection, procore_company_id, company_id, id, opts \\ [])

Show company user Show detail on a specified User.

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.
  • id (integer()): ID of the user
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.RestV13CompaniesCompanyIdUsersIdGet200Response.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v13_companies_company_id_users_id_invite_patch(connection, procore_company_id, company_id, id, opts \\ [])

@spec rest_v13_companies_company_id_users_id_invite_patch(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok, map()}
  | {:ok,
     Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:error, Tesla.Env.t()}

Send invite Send invite email to specified user.

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.
  • id (integer()): ID of the user
  • opts (keyword): Optional parameters

Returns

  • {:ok, map()} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v13_companies_company_id_users_id_patch(connection, procore_company_id, company_id, id, user, opts \\ [])

Update company user Update the specified User. #### Uploading avatar To upload avatar you must upload whole payload as multipart/form-data content-type and specify each parameter as form-data together with user[avatar] as file. #### Country and State codes The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification. See Working with Country Codes for additional information.

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.
  • id (integer()): ID of the user
  • user (Procore.Model.CompanyUser3.t):
  • opts (keyword): Optional parameters
    • :run_configurable_validations (boolean()): If true, validations are run for the corresponding Configurable Field Set.

Returns

  • {:ok, Procore.Model.NormalView2.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v13_companies_company_id_users_post(connection, procore_company_id, company_id, company_user_body, opts \\ [])

Create company user Create a new User in the specified Company. #### Uploading avatar To upload avatar you must upload whole payload as multipart/form-data content-type and specify each parameter as form-data together with user[avatar] as file. #### Country and State codes The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification. See Working with Country Codes for additional information.

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.
  • company_user_body (CompanyUserBody):
  • opts (keyword): Optional parameters
    • :run_configurable_validations (boolean()): If true, validations are run for the corresponding Configurable Field Set.

Returns

  • {:ok, Procore.Model.NormalView2.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v13_companies_company_id_users_sync_patch(connection, procore_company_id, company_id, updates, opts \\ [])

Sync company users This endpoint creates or updates a batch of Company Users. See Using Sync Actions for additional information. Requires Directory Admin permissions. #### Country and State codes The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification. See Working with Country Codes for additional information.

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.
  • updates ([Procore.Model.CompanyUsersInner.t]):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.RestV13CompaniesCompanyIdUsersSyncPatch200Response.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

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

List company users Return a list of all Users associated with a Company. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.

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[active]" (boolean()): If true, returns item(s) with a status of 'active'.
    • :"filters[created_at]" (Date.t): Return item(s) created within the specified ISO 8601 datetime range. Formats: YYYY-MM-DD...YYYY-MM-DD - Date YYYY-MM-DDTHH:MM:SSZ...YYYY-MM-DDTHH:MM:SSZ - DateTime with UTC Offset YYYY-MM-DDTHH:MM:SS+XX:00...YYYY-MM-DDTHH:MM:SS+XX:00- Datetime with Custom Offset -:"filters[updated_at]"(Date.t): Return item(s) last updated within the specified ISO 8601 datetime range. Formats:YYYY-MM-DD...YYYY-MM-DD- DateYYYY-MM-DDTHH:MM:SSZ...YYYY-MM-DDTHH:MM:SSZ- DateTime with UTC OffsetYYYY-MM-DDTHH:MM:SS+XX:00...YYYY-MM-DDTHH:MM:SS+XX:00- Datetime with Custom Offset -:"filters[vendor_id]"([integer()]): Return item(s) with the specified Vendor IDs. -:"filters[origin_id]"(String.t): Origin ID. Returns item(s) with the specified Origin ID. -:"filters[trade_id][]"([integer()]): Returns users whose vendor record is associated with the specified trade id(s). -:"filters[search]"(String.t): Return users where the search string matches the user's first name, last name, email address, keywords, job title, or company name -:sort(String.t): Return items with the specified sort. ### Returns -, ...]}on success -` on failure
Link to this function

rest_v13_users_id_get(connection, procore_company_id, company_id, id, opts \\ [])

Show company user Show detail on a specified User.

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.
  • id (integer()): ID of the user
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.CompanyUser2.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v20_companies_company_id_users_bulk_remove_project_details_patch(connection, procore_company_id, company_id, company_user_body_bulk_update_project_details, opts \\ [])

Bulk remove project details for company users on projects This endpoint allows company users to bulk remove project details on multiple projects

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • company_id (String.t): Unique identifier for the company.
  • company_user_body_bulk_update_project_details (CompanyUserBodyBulkUpdateProjectDetails):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.RestV20CompaniesCompanyIdUsersBulkRemoveProjectDetailsPatch200Response.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v20_companies_company_id_users_bulk_update_project_details_patch(connection, procore_company_id, company_id, company_user_body_bulk_update_project_details, opts \\ [])

Bulk update project details for company users on projects This endpoint allows company users to bulk update their project details on multiple projects

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • company_id (String.t): Unique identifier for the company.
  • company_user_body_bulk_update_project_details (CompanyUserBodyBulkUpdateProjectDetails):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.RestV20CompaniesCompanyIdUsersBulkUpdateProjectDetailsPatch200Response.t} on success
  • {:error, Tesla.Env.t} on failure