# ECG Documentation Version: 1.0 ## Servers ``` https://orgs.ecg-api.com ``` ## Security ### bearer Type: http Scheme: bearer Bearer Format: JWT ## Download OpenAPI description [ECG](https://ecg-api-documentation.redocly.app/_bundle/products/organizations/apis/orgs.yaml) ## Health ### Checks health of the server - [GET /healthcheck](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/health/healthcheckcontroller_check.md) ## Applications ### Lists available Application Audit Trails for all Applications. - [GET /api/applications/audit-trails](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/applications/applicationscontroller_getaudittrailsforall.md) ### Adds the Application. - [POST /api/applications](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/applications/applicationscontroller_create.md) ### Lists all the available Applications. - [GET /api/applications](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/applications/applicationscontroller_getall.md) ### Gets the Application information. - [GET /api/applications/{applicationId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/applications/applicationscontroller_getbyid.md) ### Deletes the Application information. - [DELETE /api/applications/{applicationId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/applications/applicationscontroller_deletebyid.md) ### Patches the Application information by updating the items they were provided. - [PATCH /api/applications/{applicationId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/applications/applicationscontroller_update.md) ### Gets Modules associated with Application. - [GET /api/applications/{applicationId}/modules](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/applications/applicationscontroller_getapplicationmodulesbyid.md) ### Associates ModuleIds with Application. - [POST /api/applications/{applicationId}/modules](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/applications/applicationscontroller_addapplicationmodules.md) ### Archives the Application information. - [POST /api/applications/{applicationId}/archive](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/applications/applicationscontroller_archive.md) ### Restores the Application information. - [POST /api/applications/{applicationId}/restore](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/applications/applicationscontroller_restore.md) ### Activates the Application information. - [POST /api/applications/{applicationId}/activate](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/applications/applicationscontroller_activate.md) ### Deactivates the Application information. - [POST /api/applications/{applicationId}/deactivate](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/applications/applicationscontroller_deactivate.md) ### Lists available Application Audit Trails for given ApplicationId. - [GET /api/applications/{applicationId}/audit-trails](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/applications/applicationscontroller_getaudittrailsforappid.md) ## Modules ### Lists available Module Audit Trails for all Modules - [GET /api/modules/audit-trails](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/modules/modulescontroller_getaudittrailsforall.md) ### Lists available Module Audit Trails for given moduleId - [GET /api/modules/{moduleId}/audit-trails](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/modules/modulescontroller_getaudittrailsformoduleid.md) ### Adds the Module. - [POST /api/modules](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/modules/modulescontroller_create.md) ### Lists the available Modules. - [GET /api/modules](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/modules/modulescontroller_getallmodules.md) ### Associates Applications with the Module. - [POST /api/modules/{moduleId}/applications](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/modules/modulescontroller_addmoduleapplication.md) ### Gets the Module information. - [GET /api/modules/{moduleId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/modules/modulescontroller_getbyid.md) ### Deletes the Module information. - [DELETE /api/modules/{moduleId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/modules/modulescontroller_deletebyid.md) ### Patches the Module information by updating the items they were provided. - [PATCH /api/modules/{moduleId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/modules/modulescontroller_update.md) ### Gets Permissions associated with Module. - [GET /api/modules/{moduleId}/permissions](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/modules/modulescontroller_getpermissionsbymoduleid.md) ### Adds module with permissions - [POST /api/modules/{moduleId}/permissions](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/modules/modulescontroller_putpermissionsbymodule.md) ### Deletes the application information from module - [DELETE /api/modules/{moduleId}/application/{applicationId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/modules/modulescontroller_deleteapplicationfrommodulebyid.md) ### Archives the Module information. - [POST /api/modules/{moduleId}/archive](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/modules/modulescontroller_archive.md) ### Restores the Module information. - [POST /api/modules/{moduleId}/restore](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/modules/modulescontroller_restore.md) ### Activate the Module information. - [POST /api/modules/{moduleId}/activate](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/modules/modulescontroller_activate.md) ### Deactivate the Module information. - [POST /api/modules/{moduleId}/deactivate](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/modules/modulescontroller_deactivate.md) ## Permissions ### Lists available Permission Audit Trails for all the Permissions. - [GET /api/permissions/audit-trails](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/permissions/permissionscontroller_getaudittrailsforall.md) ### Adds the Permission. - [POST /api/permissions](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/permissions/permissionscontroller_addpermission.md) ### Lists the available Permissions. - [GET /api/permissions](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/permissions/permissionscontroller_getallpermissions.md) ### Gets the Permission information. - [GET /api/permissions/{permissionId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/permissions/permissionscontroller_getbyid.md) ### Deletes the Permission information. - [DELETE /api/permissions/{permissionId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/permissions/permissionscontroller_deletebyid.md) ### Patches the Permission information by updating the items they were provided. - [PATCH /api/permissions/{permissionId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/permissions/permissionscontroller_update.md) ### Adds Module with Permission. - [PATCH /api/permissions/{permissionId}/modules/{moduleId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/permissions/permissionscontroller_addmodulebypermission.md) ### Archives the Permission information. - [POST /api/permissions/{permissionId}/archive](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/permissions/permissionscontroller_archive.md) ### Restores the Permission information. - [POST /api/permissions/{permissionId}/restore](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/permissions/permissionscontroller_restore.md) ### Activate the Permission information. - [POST /api/permissions/{permissionId}/activate](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/permissions/permissionscontroller_activate.md) ### Deactivate the Permission information. - [POST /api/permissions/{permissionId}/deactivate](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/permissions/permissionscontroller_deactivate.md) ### Lists all the available Permission Audit Trails for given Permission Id. - [GET /api/permissions/{permissionId}/audit-trails](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/permissions/permissionscontroller_getallaudittrailsbyid.md) ## Policies ### Lists available Policy Audit Trails for all the Policies. - [GET /api/policies/audit-trails](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/policies/policiescontroller_getaudittrailsforall.md) ### Adds the Policy. - [POST /api/policies](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/policies/policiescontroller_create.md) ### Lists all the available Policies. - [GET /api/policies](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/policies/policiescontroller_getall.md) ### Gets the Policy information. - [GET /api/policies/{policyId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/policies/policiescontroller_getbyid.md) ### Deletes the Policy information. - [DELETE /api/policies/{policyId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/policies/policiescontroller_deletebyid.md) ### Patches the Policy information by updating the items they were provided. - [PATCH /api/policies/{policyId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/policies/policiescontroller_update.md) ### Deletes the permissions information from policy. - [DELETE /api/policies/{policyId}/permissions/{permissionId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/policies/policiescontroller_deletebypermissionid.md) ### Associates Permission and Policy . - [POST /api/policies/{policyId}/permissions](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/policies/policiescontroller_putpermissions.md) ### Archives the Policy information. - [POST /api/policies/{policyId}/archive](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/policies/policiescontroller_archive.md) ### Restores the Policy information. - [POST /api/policies/{policyId}/restore](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/policies/policiescontroller_restore.md) ### Activate the Policy information. - [POST /api/policies/{policyId}/activate](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/policies/policiescontroller_activate.md) ### Deactivate the Policy information. - [POST /api/policies/{policyId}/deactivate](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/policies/policiescontroller_deactivate.md) ### Lists all the available Policy Audit Trails for given Policy Id. - [GET /api/policies/{policyId}/audit-trails](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/policies/policiescontroller_getallaudittrailsbyid.md) ## PermissionCaches ### Recaches all accounts. - [POST /api/permission-caches/recache](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/permissioncaches/accountpermissioncachescontroller_recache.md) ### Set Recache Flag for given User. - [POST /api/permission-caches/{cognitoUserId}/set-recache-flag](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/permissioncaches/accountpermissioncachescontroller_setpermissioncacheflag.md) ### Get's Permission Cache information for user. - [POST /api/permission-caches/{cognitoUserId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/permissioncaches/accountpermissioncachescontroller_getpermissioncache.md) ### This API serves the purpose of Re-caching the Account Permission information into the ACM for a particular user based on the 'type' of the UserId selected. - [POST /api/permission-caches/{userId}/recache](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/permissioncaches/accountpermissioncachescontroller_accountpermissionrecache.md) ## Organizations ### Lists available Organization Audit Trails for all the Organizations. - [GET /api/organizations/audit-trails](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/organizations/organizationscontroller_getaudittrailsforall.md) ### Patches the Organization Metadata information by updating the items they were provided. - [PATCH /api/organizations/{organizationId}/metadata](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/organizations/organizationscontroller_updatemetadata.md) ### Adds the Organization metadata - [POST /api/organizations/{organizationId}/metadata](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/organizations/organizationscontroller_addmetadata.md) ### Delete the organization's metadata - [DELETE /api/organizations/{organizationId}/metadata](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/organizations/organizationscontroller_delete.md) ### Patches the Address information by updating the items they were provided. - [PATCH /api/organizations/{organizationId}/addresses/{addressId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/organizations/organizationscontroller_updateaddressinfo.md) ### Deletes an organization address information from the system based on the AddressId - [DELETE /api/organizations/{organizationId}/addresses/{addressId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/organizations/organizationscontroller_deleteaddress.md) ### Gets the Organization information by metadata. - [GET /api/organizations/metadata](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/organizations/organizationscontroller_getbymetadata.md) ### Organization Created Webhook API - [POST /api/integrations/apptivo/organizations-create](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/organizations/organizationscontroller_processcreatedpartnerwebhook.md) ### Re-sync Organization's Information using SNS. - [POST /api/organizations/{organizationId}/re-sync](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/organizations/organizationscontroller_resync.md) ### Re-sync All the Organizations Information using SNS. - [POST /api/organizations/re-sync-all](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/organizations/organizationscontroller_resyncall.md) ### Organization Deleted Webhook API - [POST /api/integrations/apptivo/organizations-delete](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/organizations/organizationscontroller_processdeletedpartnerwebhook.md) ### Organization Updated Webhook API - [POST /api/integrations/apptivo/organizations-update](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/organizations/organizationscontroller_processupdatedpartnerwebhook.md) ### Adds the Organization. - [POST /api/organizations](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/organizations/organizationscontroller_create.md) ### Lists all the available Organizations. - [GET /api/organizations](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/organizations/authfactorycontroller_getall.md) ### Syncs the Organization information into the CRM - [POST /api/organizations/{organizationId}/crm-sync](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/organizations/organizationscontroller_crmsync.md) ### Gets the Organization information. - [GET /api/organizations/{organizationId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/organizations/organizationscontroller_getbyid.md) ### Deletes the Organization information. - [DELETE /api/organizations/{organizationId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/organizations/organizationscontroller_deletebyid.md) ### Patches the Organization information by updating the items they were provided. - [PATCH /api/organizations/{organizationId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/organizations/organizationscontroller_update.md) ### Archives the Organization information. - [POST /api/organizations/{organizationId}/archive](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/organizations/organizationscontroller_archive.md) ### Restores the Organization information. - [POST /api/organizations/{organizationId}/restore](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/organizations/organizationscontroller_restore.md) ### Activate the Organization information. - [POST /api/organizations/{organizationId}/activate](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/organizations/organizationscontroller_activate.md) ### Deactivate the Organization information. - [POST /api/organizations/{organizationId}/deactivate](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/organizations/organizationscontroller_deactivate.md) ### Suspend the Organization information. - [POST /api/organizations/{organizationId}/suspend](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/organizations/organizationscontroller_suspended.md) ### Gets Organization Hierarchy - [GET /api/organizations/{organizationId}/hierarchy](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/organizations/organizationscontroller_getorghierarchy.md) ### Lists the Organization Ancestry Information(Parent Organizations Information) for the particular OrganizationId. - [GET /api/organizations/{organizationId}/ancestries](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/organizations/organizationscontroller_listancestries.md) ### Updates Organization's Ancestry Nodes Information and Re-Syncs the Ancestry information into the Redis. - [POST /api/organizations/{organizationId}/ancestries/re-sync](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/organizations/organizationscontroller_resyncancestries.md) ### Updates Ancestry Nodes Information for all the Organizations and Re-Syncs the Ancestry information into the Redis. CRON - Every Week - [POST /api/organizations/ancestries/re-sync-all](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/organizations/organizationscontroller_updateancestrynodes.md) ### Lists all the available Organization Audit Trails for given Organization Id. - [GET /api/organizations/{organizationId}/audit-trails](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/organizations/organizationscontroller_getallaudittrailsbyid.md) ### Gets the Organization Setup Status information. - [GET /api/organizations/{organizationId}/setup-status](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/organizations/organizationscontroller_setupstatus.md) ### Creates a new organization address - [POST /api/organizations/{organizationId}/addresses](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/organizations/organizationscontroller_createaddresses.md) ### Lists the organization addresses - [GET /api/organizations/{organizationId}/addresses](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/organizations/organizationscontroller_listaddresses.md) ### Gets the on boarding Partner for an Organization. (deprecated) - [GET /api/organizations/{organizationId}/on-boarding-partners](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/organizations/organizationscontroller_getonboardingpartner.md) ### Deletes the on boarding Partner from Organization. (deprecated) - [DELETE /api/organizations/{organizationId}/on-boarding-partners/{partnerId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/organizations/organizationscontroller_deleteonboardingpartner.md) ### Adds the on boarding Partner for Organization. (deprecated) - [POST /api/organizations/{organizationId}/on-boarding-partners/{partnerId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/organizations/organizationscontroller_createonboardpartner.md) ### The purpose of this API is to run a background script that synchronizes all organization types, ensuring they are set to either 1 or 2 based on the organization’s type. (deprecated) - [POST /api/organizations/sync/types](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/organizations/organizationscontroller_script.md) ## SeedData ### List the organization types - [GET /api/seed-data/organization-types](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/seeddata/seeddatacontroller_getorganizationtypes.md) ### List the organization status types - [GET /api/seed-data/organization-status-types](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/seeddata/seeddatacontroller_getorganizationstatustypes.md) ### List the Subscriber status types - [GET /api/seed-data/subscriber-status-types](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/seeddata/seeddatacontroller_getosubscriberstatustypes.md) ### List the salutation types - [GET /api/seed-data/salutation-types](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/seeddata/seeddatacontroller_getsalutationtypes.md) ### List the Address types - [GET /api/seed-data/address-types](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/seeddata/seeddatacontroller_getaddresstypes.md) ### List the Staff Member types - [GET /api/seed-data/staff-member-types](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/seeddata/seeddatacontroller_getstaffmembertypes.md) ### List ECG Products. - [GET /api/seed-data/ecg-products](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/seeddata/seeddatacontroller_getecgproducts.md) ### Lists the time zones - [GET /api/seed-data/timezones](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/seeddata/seeddatacontroller_gettimezones.md) ### List the Apptivo Event Names - [GET /api/seed-data/event-names](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/seeddata/seeddatacontroller_getapptivopayloadtypes.md) ### List the Phone Types. - [GET /api/seed-data/phone-types](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/seeddata/seeddatacontroller_listphonetypes.md) ### Lists the Region Codes. - [GET /api/seed-data/region-codes](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/seeddata/seeddatacontroller_listregion.md) ### Lists all the available Country Codes. - [GET /api/seed-data/country-codes](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/seeddata/seeddatacontroller_listcountrycodes.md) ### Lists all the available State Codes. - [GET /api/seed-data/state-codes](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/seeddata/seeddatacontroller_liststatecodes.md) ### Lists all of the available blood types. - [GET /api/seed-data/blood-types](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/seeddata/seeddatacontroller_listbloodtypes.md) ## Statistics ### Lists all the available member statistics. - [GET /api/member-statistics](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/statistics/statisticscontroller_getmemberstatistics.md) ### Lists all the available organization statistics. - [GET /api/organizations/{organizationId}/member-statistics](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/statistics/statisticscontroller_getorgmemberstatistics.md) ## Organizations-Type ### Migrate Organization from type=2 to type=1 for all the organizations. - [POST /api/organizations/type-update](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/organizations-type/organizationstypecontroller_getaudittrailsforall.md) ## ApptivoPayloads ### Lists all the available Apptivo Payloads. - [GET /api/apptivo-payloads](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/apptivopayloads/apptivopayloadcontroller_getall.md) ## Users ### Lists all the available Users - [GET /api/users](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/users/usercontroller_listusers.md) ### Lists available Account Audit Trails for all users - [GET /api/accounts/audit-trails](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/users/usercontroller_getaudittrailsforall.md) ### Get's User account information based on PersonId or CognitoUserId. - [GET /api/users/{userId}/accounts](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/users/usercontroller_getaccountbytype.md) ### BackUp Cognito Users Information. - [POST /api/users/backup](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/users/usercontroller_backupcognitousers.md) ### Restore Cognito Users Information. - [POST /api/users/restore](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/users/usercontroller_restorecognitousers.md) ### Based on a user's email address, this API deletes their account information and removes them from cognito system - [POST /api/users/remove](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/users/usercontroller_removeuser.md) ### The purpose of this API is to delete the user information from the system - [DELETE /api/users/{userId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/users/usercontroller_removeuserbyid.md) ## People ### Resets User Password. - [POST /api/people/{personId}/reset-password](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/people/peoplecontroller_resetuserpassword.md) ### Resends the User Credentials - [POST /api/people/{personId}/resend-credentials](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/people/peoplecontroller_resendcredentials.md) ### Adds the Person Information. - [POST /api/people](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/people/peoplecontroller_addperson.md) ### Adds the User account for a given Person. - [POST /api/people/{personId}/accounts](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/people/peoplecontroller_adduseraccount.md) ### Updates the User Account for a given Person. This API serves the purpose of updating the User Account Email Address and sets new password for the same. - [PATCH /api/people/{personId}/accounts](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/people/peoplecontroller_updateaccountemail.md) ### Gets the Person information by Id. - [GET /api/people/{personId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/people/peoplecontroller_getpersonbyid.md) ### Patches the Person information by updating the items. - [PATCH /api/people/{personId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/people/peoplecontroller_update.md) ### Changes Account Password for a given Person. - [POST /api/people/{personId}/change-password](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/people/peoplecontroller_changepassword.md) ### Re-sync single person's information - [POST /api/people/re-sync](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/people/peoplecontroller_resync.md) ### Lists available Account Audit Trails for given PersonId - [GET /api/people/{personId}/accounts/audit-trails](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/people/peoplecontroller_getaudittrails.md) ### Re-sync person's information in batch of 100 person Ids - [POST /api/people/re-sync-batch](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/people/peoplecontroller_resyncbatch.md) ## Staff-Members ### Lists available Staff Member Audit Trails for all staffMembers - [GET /api/staff-members/audit-trails](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/staff-members/staffmemberscontroller_getaudittrailsforall.md) ### Lists available Organization Block List Audit Trails for all staffMember - [GET /api/organization-block-lists/audit-trails](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/staff-members/staffmemberscontroller_getorgblocklistaudittrailsforall.md) ### Lists all the available Staff Members. - [GET /api/organizations/{organizationId}/staff-members](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/staff-members/staffmemberscontroller_getallstaffmembers.md) ### Adds the Staff Member. - [POST /api/organizations/{organizationId}/staff-members](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/staff-members/staffmemberscontroller_addstaffmember.md) ### Lists all the designated ECG Admins and Staff Members based on the OrganizationID. - [GET /api/organizations/{organizationId}/designated-staff-members](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/staff-members/staffmemberscontroller_designatedstaffmembers.md) ### Get the Staff Member for organization. - [GET /api/organizations/{organizationId}/staff-members/{personId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/staff-members/staffmemberscontroller_getstaffmemberbyid.md) ### Patches the Staff Member information by updating the items. - [PATCH /api/organizations/{organizationId}/staff-members/{personId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/staff-members/staffmemberscontroller_update.md) ### Deletes the Staff Member information for an organization from the system, and will also remove the account information from cognito if any account information is associated for that staff member. - [DELETE /api/organizations/{organizationId}/staff-members/{personId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/staff-members/staffmemberscontroller_deletebyid.md) ### Get the Staff Member by person Id - [GET /api/staff-members/{personId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/staff-members/staffmemberscontroller_getstaffmemberbypersonid.md) ### Archive the Staff Member for organization. - [POST /api/organizations/{organizationId}/staff-members/{personId}/archive](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/staff-members/staffmemberscontroller_archivestaffmember.md) ### Restore the Staff Member for organization. - [POST /api/organizations/{organizationId}/staff-members/{personId}/restore](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/staff-members/staffmemberscontroller_restorestaffmember.md) ### Activate the Staff Member for organization. - [POST /api/organizations/{organizationId}/staff-members/{personId}/activate](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/staff-members/staffmemberscontroller_activatestaffmember.md) ### Deactivate the Staff Member for organization. - [POST /api/organizations/{organizationId}/staff-members/{personId}/deactivate](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/staff-members/staffmemberscontroller_deactivatestaffmember.md) ### Lists available Staff Member Audit Trails for given personId - [GET /api/organizations/{organizationId}/staff-members/{personId}/audit-trails](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/staff-members/staffmemberscontroller_getaudittrailsforid.md) ### Lists available Organization Block List Audit Trails for given personId - [GET /api/staff-members/{personId}/organization-block-lists/audit-trails](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/staff-members/staffmemberscontroller_getorgblocklistaudittrails.md) ### List Blocked Organizations for Staff Member. - [GET /api/staff-members/{personId}/blocked-organizations](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/staff-members/staffmemberscontroller_listblockedorganizations.md) ### Block Organization for Staff Member. - [POST /api/organizations/{organizationId}/staff-members/{personId}/block](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/staff-members/staffmemberscontroller_blockorganization.md) ### Unblock Organization for Staff Member. - [POST /api/organizations/{organizationId}/staff-members/{personId}/unblock](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/staff-members/staffmemberscontroller_unblockorganization.md) ### Gets Staff Member Organization Hierarchy - [GET /api/staff-members/{personId}/organizations](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/staff-members/staffmemberscontroller_getorghierarchy.md) ## Organization Transfer ### The purpose of this API to transfer an organization from source parent organization to target parent organization. - [POST /api/v1/organization-transfers/{organizationId}/initiate](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/organization-transfer/organizationtransferscontroller_transferorg.md): Permissions needed - organization.transfer ### This API retrieves the count of impacted subscribers due to the organization transfer. - [GET /api/v1/organization-transfers/{organizationId}/impacted-subscribers/count](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/organization-transfer/organizationtransferscontroller_impactedsubscriberscount.md): Permissions needed - organization.transfer ### The purpose of this API to list all the available Organization Transfer history for organization based on query in paginated format. - [GET /api/v1/organization-transfers/{organizationId}/histories](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/organization-transfer/organizationtransferscontroller_listhistories.md): Permissions needed - organization.transfer ## Subscribers ### An Advanced Search for listing all the Subscribers - [GET /api/subscribers/advanced-search](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers/subscriberscontroller_advancedsearch.md) ### Syncs the Subscriber information into the CRM - [POST /api/subscribers/{personId}/crm-sync](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers/subscriberscontroller_syncsubscriber.md) ### Lists available Subscriber Audit Trails for all Subscribers. - [GET /api/subscribers/audit-trails](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers/subscriberscontroller_getaudittrailsforallsub.md) ### Lists available Subscriber Access Rights Audit Trails for all subscriberAccess - [GET /api/subscribers/access-rights/audit-trails](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers/subscriberscontroller_getsubscriberaccessaudittrailsforall.md) ### Subscriber Created Webhook API - [POST /api/subscribers/integrations/apptivo/subscribers-create](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers/subscriberscontroller_processcreatedsubscriberwebhook.md) ### Subscriber updated Webhook API - [POST /api/subscribers/integrations/apptivo/subscribers-update](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers/subscriberscontroller_processupdatedsubscriberwebhook.md) ### Subscriber deleted Webhook API - [POST /api/subscribers/integrations/apptivo/subscribers-delete](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers/subscriberscontroller_processdeletedsubscriberwebhook.md) ### Gets the Subscriber information by metadata. - [GET /api/subscribers/metadata](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers/subscriberscontroller_getbymetadata.md) ### Adds the Policy Groups to Subscriber. - [POST /api/subscribers/{personId}/policy-groups](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers/subscriberscontroller_addpolicygroupstosubscriber.md) ### Patches the Subscriber Access information by updating the items they were provided. - [PATCH /api/subscribers/{personId}/access-rights/{subscriberAccessId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers/subscriberscontroller_updatesubscriberaccessbyid.md) ### Adds the Subscriber Access. - [POST /api/subscribers/{personId}/access-rights](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers/subscriberscontroller_createsubscriberaccess.md) ### Archives the Subscriber Access information. - [POST /api/subscribers/{personId}/access-rights/{subscriberAccessId}/archive](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers/subscriberscontroller_archivesubscriberaccess.md) ### Restores the Subscriber Access information. - [POST /api/subscribers/{personId}/access-rights/{subscriberAccessId}/restore](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers/subscriberscontroller_restoresubscriberaccess.md) ### Activate the Subscriber Access information. - [POST /api/subscribers/{personId}/access-rights/{subscriberAccessId}/activate](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers/subscriberscontroller_activatesubscriberaccess.md) ### Deactivate the Subscriber Access information. - [POST /api/subscribers/{personId}/access-rights/{subscriberAccessId}/deactivate](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers/subscriberscontroller_deactivatesubscriberaccess.md) ### Adds the Subscriber. - [POST /api/subscribers](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers/subscriberscontroller_create.md) ### Lists all the available Subscribers. - [GET /api/subscribers](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers/subscriberscontroller_getall.md) ### Adds the Subscriber By Id. - [POST /api/subscribers/{personId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers/subscriberscontroller_createsubscriberbyid.md) ### Gets the Subscriber information. - [GET /api/subscribers/{personId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers/subscriberscontroller_getbyid.md) ### Deletes the Subscriber information. - [DELETE /api/subscribers/{personId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers/subscriberscontroller_deletebyid.md) ### Patches the Subscriber information by updating the items they were provided. - [PATCH /api/subscribers/{personId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers/subscriberscontroller_updatesubscriberbyid.md) ### Gets the Subscriber information by legacy Identifier. - [GET /api/subscribers/legacy-identifier/{legacyIdentifier}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers/subscriberscontroller_getbylegacyidentifierid.md) ### Archives the Subscriber information. - [POST /api/subscribers/{personId}/archive](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers/subscriberscontroller_archive.md) ### Restores the Subscriber information. - [POST /api/subscribers/{personId}/restore](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers/subscriberscontroller_restore.md) ### Activate the Subscriber information. - [POST /api/subscribers/{personId}/activate](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers/subscriberscontroller_activate.md) ### Deactivate the Subscriber information. - [POST /api/subscribers/{personId}/deactivate](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers/subscriberscontroller_deactivate.md) ### Lists available Subscriber Audit Trails for given SubscriberId - [GET /api/subscribers/{personId}/audit-trails](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers/subscriberscontroller_getaudittrailsforsubid.md) ### Lists available devices for a given Subscriber - [GET /api/subscribers/{personId}/devices](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers/subscriberscontroller_getdevicesforsubid.md): If active query param not passed both active & deactivated devices will be returned ### Lists available Subscriber Access Rights Audit Trails for given subscriberAccessId - [GET /api/subscribers/{personId}/access-rights/{subscriberAccessId}/audit-trails](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers/subscriberscontroller_getallsubscriberaccessaudittrails.md) ### Adds the Subscriber metadata - [POST /api/subscribers/{personId}/metadata](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers/subscriberscontroller_addmetadata.md) ### Update subscriber's metadata - [PATCH /api/subscribers/{personId}/metadata](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers/subscriberscontroller_updatemetadata.md) ### Delete the Subscriber's metadata - [DELETE /api/subscribers/{personId}/metadata](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers/subscriberscontroller_delete.md) ### Anonymize the Subscriber Information. - [POST /api/subscribers/{personId}/anonymize](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers/subscriberscontroller_anonymizesubscriber.md) ## Subscribers Profile ### Creates a new subscriber - [POST /subscribers-profile/{subscriberId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/subscribersprofilecontroller_create.md) ### Get Subscriber details - [GET /subscribers-profile/{subscriberId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/subscribersprofilecontroller_findbyid.md) ### Updates the subscriber information - [PATCH /subscribers-profile/{subscriberId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/subscribersprofilecontroller_update.md) ### Deletes the subscriber information - [DELETE /subscribers-profile/{subscriberId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/subscribersprofilecontroller_delete.md) ### Adds the Subscriber metadata - [POST /subscribers-profile/{subscriberId}/metadata](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/subscribersprofilecontroller_addmetadata.md) ### Update a subscriber's metadata - [PATCH /subscribers-profile/{subscriberId}/metadata](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/subscribersprofilecontroller_updatemetadata.md) ### Delete a field from the Subscriber's metadata - [DELETE /subscribers-profile/{subscriberId}/metadata](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/subscribersprofilecontroller_deletemetadata.md) ### Checks if subscriber info is complete. - [GET /subscribers-profile/{subscriberId}/is-complete](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/subscribersprofilecontroller_issubscribercomplete.md) ### Creates a new subscriber address - [POST /subscribers-profile/{subscriberId}/addresses](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/contactinformationcontroller_createaddress.md) ### Get subscriber addresses - [GET /subscribers-profile/{subscriberId}/addresses](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/contactinformationcontroller_getmanyaddresses.md) ### Get subscriber address by id - [GET /subscribers-profile/{subscriberId}/addresses/{addressId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/contactinformationcontroller_getaddress.md) ### Deletes a subscriber address by id - [DELETE /subscribers-profile/{subscriberId}/addresses/{addressId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/contactinformationcontroller_deleteaddress.md) ### Updates a subscriber address by id - [PATCH /subscribers-profile/{subscriberId}/addresses/{addressId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/contactinformationcontroller_updateaddress.md) ### Creates a subscriber phone number - [POST /subscribers-profile/{subscriberId}/phone-numbers](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/contactinformationcontroller_createphonenumber.md) ### Gets subscriber phone numbers - [GET /subscribers-profile/{subscriberId}/phone-numbers](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/contactinformationcontroller_getphonenumbers.md) ### Gets a subscriber phone number by id - [GET /subscribers-profile/{subscriberId}/phone-numbers/{phoneNumberId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/contactinformationcontroller_getphonenumber.md) ### Deletes a subscriber phone number by id - [DELETE /subscribers-profile/{subscriberId}/phone-numbers/{phoneNumberId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/contactinformationcontroller_deletephonenumber.md) ### Updates a subscriber phone number by id - [PATCH /subscribers-profile/{subscriberId}/phone-numbers/{phoneNumberId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/contactinformationcontroller_updatephonenumber.md) ### Gets the Subscribers Call List - [GET /subscribers-profile/{subscriberId}/calls](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/responsiblepartycontroller_subscriberscalllist.md) ### Reorders responsible parties' priorities - [POST /subscribers-profile/{subscriberId}/reorder-responsible-parties](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/responsiblepartycontroller_reorderresponsibleparties.md) ### Creates responsible parties - [POST /subscribers-profile/{subscriberId}/responsible-parties](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/responsiblepartycontroller_createresponsibleparties.md) ### Lists all available responsible parties - [GET /subscribers-profile/{subscriberId}/responsible-parties](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/responsiblepartycontroller_getallresponsibleparties.md) ### Gets a responsible party. - [GET /subscribers-profile/{subscriberId}/responsible-parties/{responsiblePartyId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/responsiblepartycontroller_getresponsibleparty.md) ### Patches a responsible party. - [PATCH /subscribers-profile/{subscriberId}/responsible-parties/{responsiblePartyId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/responsiblepartycontroller_updateresponsibleparty.md) ### Deletes a Responsible Party. - [DELETE /subscribers-profile/{subscriberId}/responsible-parties/{responsiblePartyId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/responsiblepartycontroller_deletebyid.md) ### Patches a responsible party's phone numbers. - [PATCH /subscribers-profile/{subscriberId}/responsible-parties/{responsiblePartyId}/phone-numbers/{phoneNumberId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/responsiblepartycontroller_updateresponsiblepartyphonenumbers.md) ### Deletes a Responsible Party Phone. - [DELETE /subscribers-profile/{subscriberId}/responsible-parties/{responsiblePartyId}/phone-numbers/{phoneNumberId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/responsiblepartycontroller_deleteresponsiblepartyphonebyid.md) ### Creates a Responsible Party Phone. - [POST /subscribers-profile/{subscriberId}/responsible-parties/{responsiblePartyId}/phone-numbers](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/responsiblepartycontroller_createresponsiblepartyphonenumber.md) ### Patches a responsible party's addresses. - [PATCH /subscribers-profile/{subscriberId}/responsible-parties/{responsiblePartyId}/addresses/{addressId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/responsiblepartycontroller_updateresponsiblepartyaddresses.md) ### Deletes a Responsible Party Address. - [DELETE /subscribers-profile/{subscriberId}/responsible-parties/{responsiblePartyId}/addresses/{addressId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/responsiblepartycontroller_deleteresponsiblepartyaddressbyid.md) ### Creates a Responsible Party Address. - [POST /subscribers-profile/{subscriberId}/responsible-parties/{responsiblePartyId}/addresses](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/responsiblepartycontroller_createresponsiblepartyaddress.md) ### Archives a responsible party. - [POST /subscribers-profile/{subscriberId}/responsible-parties/{responsiblePartyId}/archive](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/responsiblepartycontroller_archiveresponsibleparty.md) ### Restores a responsible party. - [POST /subscribers-profile/{subscriberId}/responsible-parties/{responsiblePartyId}/restore](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/responsiblepartycontroller_restoreresponsibleparty.md) ### Activates a responsible party. - [POST /subscribers-profile/{subscriberId}/responsible-parties/{responsiblePartyId}/activate](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/responsiblepartycontroller_activateresponsibleparty.md) ### Deactivates a responsible party. - [POST /subscribers-profile/{subscriberId}/responsible-parties/{responsiblePartyId}/deactivate](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/responsiblepartycontroller_deactivateresponsibleparty.md) ### Assigns a blood type to a subscriber - [POST /subscribers-profile/{subscriberId}/blood-type](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/bloodtypecontroller_assignbloodtype.md) ### Get subscriber blood type by id - [GET /subscribers-profile/{subscriberId}/blood-type](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/bloodtypecontroller_getbloodtype.md) ### Updates subscriber blood type by id - [PATCH /subscribers-profile/{subscriberId}/blood-type](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/bloodtypecontroller_updatebloodtype.md) ### creates a new subscriber medical condition - [POST /subscribers-profile/{subscriberId}/medical-conditions](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/medicalconditionscontroller_createmedicalconditions.md) ### Retrieves all medical conditions for a subscriber - [GET /subscribers-profile/{subscriberId}/medical-conditions](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/medicalconditionscontroller_getallmedicalconditions.md) ### Retrieves a medical condition by Id - [GET /subscribers-profile/{subscriberId}/medical-conditions/{conditionId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/medicalconditionscontroller_getmedicalcondition.md) ### Updates subscriber medical condition - [PATCH /subscribers-profile/{subscriberId}/medical-conditions/{conditionId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/medicalconditionscontroller_update.md) ### Archives subscriber medical condition - [POST /subscribers-profile/{subscriberId}/medical-conditions/{conditionId}/archive](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/medicalconditionscontroller_archive.md) ### Restores subscriber medical condition - [POST /subscribers-profile/{subscriberId}/medical-conditions/{conditionId}/restore](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/medicalconditionscontroller_restore.md) ### Retrieves all medical procedures for a subscriber - [GET /subscribers-profile/{subscriberId}/medical-procedures](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/medicalprocedurecontroller_getallmedicalprocedures.md) ### Creates a new medical procedure for the subscriber's profile - [POST /subscribers-profile/{subscriberId}/medical-procedures](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/medicalprocedurecontroller_createmedicalprocedure.md) ### Retrieves a medical procedure by Id - [GET /subscribers-profile/{subscriberId}/medical-procedures/{procedureId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/medicalprocedurecontroller_getmedicalprocedure.md) ### Updates subscriber medical procedure - [PATCH /subscribers-profile/{subscriberId}/medical-procedures/{procedureId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/medicalprocedurecontroller_update.md) ### Archives subscriber medical procedure - [POST /subscribers-profile/{subscriberId}/medical-procedures/{procedureId}/archive](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/medicalprocedurecontroller_archive.md) ### Restores subscriber medical procedure - [POST /subscribers-profile/{subscriberId}/medical-procedures/{procedureId}/restore](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/medicalprocedurecontroller_restore.md) ### Creates a new medical allergy for a subscriber - [POST /subscriber-profile/{subscriberId}/medical-allergies](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/medallergiescontroller_create.md) ### Lists medical allergies for a subscriber - [GET /subscriber-profile/{subscriberId}/medical-allergies](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/medallergiescontroller_findall.md) ### Gets a medical allergy for a subscriber by id - [GET /subscriber-profile/{subscriberId}/medical-allergies/{allergyId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/medallergiescontroller_findbyid.md) ### Updates a medical allergy for a subscriber by id - [PATCH /subscriber-profile/{subscriberId}/medical-allergies/{allergyId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/medallergiescontroller_update.md) ### Archives a medical allergy for a subscriber - [POST /subscriber-profile/{subscriberId}/medical-allergies/{allergyId}/archive](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/medallergiescontroller_archive.md) ### Restores a medical allergy for a subscriber - [POST /subscriber-profile/{subscriberId}/medical-allergies/{allergyId}/restore](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscribers-profile/medallergiescontroller_restore.md) ## Subscriber Transfer ### Check which subscribers from a list have transfer history. - [POST /api/subscribers/transfers/history-check](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscriber-transfer/subscribertransfercontroller_checktransferhistory.md) ### The purpose of this API to transfer subscriber from source organization to target organization. - [PUT /api/subscribers/{personId}/transfers](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscriber-transfer/subscribertransfercontroller_transfersubscriber.md): Permissions needed - subscribers.admin ### The purpose of this API to list the transfer subscriber history for subscriber. - [GET /api/subscribers/{personId}/transfers](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscriber-transfer/subscribertransfercontroller_list.md): Permissions needed - subscribers.admin ### The purpose of this API to re-sync the process of transfer subscriber from source organization to target organization. - [POST /api/subscribers/{personId}/transfers/re-sync](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscriber-transfer/subscribertransfercontroller_transfersubscriberresync.md): Permissions needed - subscribers.admin ### This API endpoint is designed to provide the status of a subscriber transfer operation identified by the personId - [GET /api/subscribers/{personId}/transfers/status](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscriber-transfer/subscribertransfercontroller_transfersubscriberstatus.md): Permissions needed - subscribers.admin ### The purpose of this API to Lists available Subscriber Transfer Activity. - [GET /api/subscriber-transfer-activities](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscriber-transfer/subscribertransferactivitycontroller_transfersubscriber.md): Permissions needed - subscribers.admin ## Batch Subscriber Transfers ### This API endpoint facilitates the initiation of a batch subscriber transfer operation, allowing users to transfer multiple subscribers in a single request. - [POST /api/organizations/{organizationId}/batch-transfers](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/batch-subscriber-transfers/batchsubscribertransfercontroller_batchsubscribertransfer.md): Permissions needed - subscribers.admin ### The purpose of this API to fetch information about batch subscriber transfers for a specific organization. - [GET /api/organizations/{organizationId}/batch-transfers](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/batch-subscriber-transfers/batchsubscribertransfercontroller_list.md): Permissions needed - subscribers.read ### The purpose of this API to re-sync subscriber transfers with a status of failure for a specific batch within an organization. - [POST /api/organizations/{organizationId}/batch-transfers/{batchId}/re-sync](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/batch-subscriber-transfers/batchsubscribertransfercontroller_transfersubscriberbatchresync.md): Permissions needed - subscribers.admin ### The purpose of this API to retrieve details for a specific batch subscriber transfer within an organization. - [GET /api/organizations/{organizationId}/batch-transfers/{batchId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/batch-subscriber-transfers/batchsubscribertransfercontroller_getbyid.md): Permissions needed - subscribers.read ### The purpose of this API to provide the status details of a specific batch transfer within an organization. It allows you to include subscriber information in the response. - [GET /api/organizations/{organizationId}/batch-transfers/{batchId}/status](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/batch-subscriber-transfers/batchsubscribertransfercontroller_getbatchtransferstatus.md): Permissions needed - subscribers.admin ## EcgAdmins ### Lists available ECG Admin Audit Trails for all the ECG Admins. - [GET /api/ecg-admins/audit-trails](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/ecgadmins/ecgadmincontroller_getaudittrailsforall.md) ### Patches the ECG Admin information by updating the items. - [PATCH /api/ecg-admins/{personId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/ecgadmins/ecgadmincontroller_update.md) ### Get the ECG Admin by Id. - [GET /api/ecg-admins/{personId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/ecgadmins/ecgadmincontroller_getecgadminbyid.md) ### Lists all the available ECG Admin. - [GET /api/ecg-admins](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/ecgadmins/ecgadmincontroller_getall.md) ### Adds the ECG Admin. - [POST /api/ecg-admins](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/ecgadmins/ecgadmincontroller_addecgadmin.md) ### Activate the ECG Admin information. - [POST /api/ecg-admins/{personId}/activate](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/ecgadmins/ecgadmincontroller_activate.md) ### Deactivate the ECG Admin information. - [POST /api/ecg-admins/{personId}/deactivate](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/ecgadmins/ecgadmincontroller_deactivate.md) ### Lists all the available ECG Admin Audit Trails for given ECG Admin Id. - [GET /api/ecg-admins/{personId}/audit-trails](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/ecgadmins/ecgadmincontroller_getallaudittrailsbyid.md) ## Partners (Deprecated) ### Lists available Partner Audit Trails for all partners. - [GET /api/partners/audit-trails](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partners-(deprecated)/partnercontroller_getaaudittrailsforall.md) ### Lists all the available Partners. - [GET /api/partners](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partners-(deprecated)/partnercontroller_getall.md) ### Add the Partner. - [POST /api/partners](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partners-(deprecated)/partnercontroller_addpartner.md) ### Get the Partner by Id. - [GET /api/partners/{partnerId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partners-(deprecated)/partnercontroller_getpartnerbyid.md) ### Patches the Partner information by updating the items. - [PATCH /api/partners/{partnerId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partners-(deprecated)/partnercontroller_update.md) ### Lists available Partner Audit Trails for given partnerId. - [GET /api/partners/{partnerId}/audit-trails](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partners-(deprecated)/partnercontroller_getaaudittrailsforid.md) ### Syncs the Partner information in CRM - [POST /api/partners/{partnerId}/crm-sync](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partners-(deprecated)/partnercontroller_crmsync.md) ### Manages to Sync the customerId information from the Partner's legacy-identifier. Please Note this endpoint is for testing purpose only and will be removed shortly. - [POST /api/partners/sync/customerId](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partners-(deprecated)/partnercontroller_synccontactid.md) ### Partner Created Webhook API (deprecated) - [POST /api/integrations/apptivo/partners-create](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partners-(deprecated)/partnercontroller_processcreatedpartnerwebhook.md) ### Partner Deleted Webhook API (deprecated) - [POST /api/integrations/apptivo/partners-delete](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partners-(deprecated)/partnercontroller_processdeletedpartnerwebhook.md) ### Partner Updated Webhook API (deprecated) - [POST /api/integrations/apptivo/partners-update](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partners-(deprecated)/partnercontroller_processupdatedpartnerwebhook.md) ### The script will scan the organization table and set the customer_id field to NULL wherever it is currently populated for OLD PARTNER TABLE ENTRIES ONLY. (deprecated) - [POST /api/partners/reset-organization-customers](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partners-(deprecated)/partnercontroller_onboardpartnersv2.md) ## PartnerTypes (Deprecated) ### Lists available Partner Type Rule Audit Trails for all. - [GET /api/partner-types/children/audit-trails](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partnertypes-(deprecated)/partnertypecontroller_getpartnertyperuleaudittrailsforall.md) ### Lists all the available Partner Direct Commissions Audit Trails for all. - [GET /api/partner-types/direct-commissions/audit-trails](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partnertypes-(deprecated)/partnertypecontroller_getcommissionsaudittrailsforall.md) ### Lists Partner Indirect Commissions Audit Trails for all. - [GET /api/partner-types/indirect-commissions/audit-trails](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partnertypes-(deprecated)/partnertypecontroller_getaudittrailsforallcommission.md) ### Lists available Partner Type Audit Trails for all the Partner Types. - [GET /api/partner-types/audit-trails](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partnertypes-(deprecated)/partnertypecontroller_getaudittrailsforall.md) ### Adds the Partner type. - [POST /api/partner-types](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partnertypes-(deprecated)/partnertypecontroller_addpartnertype.md) ### Lists all the available Partner Types. - [GET /api/partner-types](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partnertypes-(deprecated)/partnertypecontroller_getallpartnertype.md) ### Gets the Partner Type Information. - [GET /api/partner-types/{partnerTypeId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partnertypes-(deprecated)/partnertypecontroller_getpartnertype.md) ### Deletes the Partner Type Information. - [DELETE /api/partner-types/{partnerTypeId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partnertypes-(deprecated)/partnertypecontroller_deletepartnertype.md) ### Patches the Partner Type information by updating the items they were provided. - [PATCH /api/partner-types/{partnerTypeId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partnertypes-(deprecated)/partnertypecontroller_patchpartnertype.md) ### Activates the Partner Type information. - [POST /api/partner-types/{partnerTypeId}/activate](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partnertypes-(deprecated)/partnertypecontroller_activatepartnertype.md) ### Deactivates the Partner Type information. - [POST /api/partner-types/{partnerTypeId}/deactivate](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partnertypes-(deprecated)/partnertypecontroller_deactivatepartnertype.md) ### Lists all the available Partner Type Children. - [GET /api/partner-types/{partnerTypeId}/children](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partnertypes-(deprecated)/partnertypecontroller_getpartnertypechildren.md) ### Adds the Partner Type Children. - [POST /api/partner-types/{partnerTypeId}/children](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partnertypes-(deprecated)/partnertypecontroller_addpartnertypechildren.md) ### Deletes the Partner Type Child. - [DELETE /api/partner-types/{partnerTypeId}/children/{childrenId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partnertypes-(deprecated)/partnertypecontroller_deletepartnertyperule.md) ### Gets the Partner Type Indirect Commissions - [GET /api/partner-types/{partnerTypeId}/children/{childrenId}/indirect-commissions](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partnertypes-(deprecated)/partnertypecontroller_getindirectcommission.md) ### Gets the Partner Type Commission. - [GET /api/partner-types/{partnerTypeId}/direct-commissions/{commissionId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partnertypes-(deprecated)/partnertypecontroller_getpartnertypecommission.md) ### Patches the Partner Type Commission information by updating the items they were provided. - [PATCH /api/partner-types/{partnerTypeId}/direct-commissions/{commissionId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partnertypes-(deprecated)/partnertypecontroller_updatepartnertypecommission.md) ### Deletes the Partner Type Commission information. - [DELETE /api/partner-types/{partnerTypeId}/direct-commissions/{commissionId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partnertypes-(deprecated)/partnertypecontroller_deletepartnertypecommission.md) ### Adds the Partner Type Commission. - [POST /api/partner-types/{partnerTypeId}/direct-commissions](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partnertypes-(deprecated)/partnertypecontroller_addpartnertypecommission.md) ### Lists all the available Partner Type Direct Commissions - [GET /api/partner-types/{partnerTypeId}/direct-commissions](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partnertypes-(deprecated)/partnertypecontroller_getpartnertypedirectcommissions.md) ### Lists all the available Partner Type Indirect Commissions - [GET /api/partner-types/{partnerTypeId}/indirect-commissions](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partnertypes-(deprecated)/partnertypecontroller_getpartnertypeindirectcommissions.md) ### Lists all the available Partner Type Audit Trails for given Partner Type Id. - [GET /api/partner-types/{partnerTypeId}/audit-trails](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partnertypes-(deprecated)/partnertypecontroller_getpartnertypeaudittrailsbyid.md) ### Lists available Partner Type Rule Audit Trails for given Id. - [GET /api/partner-types/{partnerTypeId}/children/audit-trails](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partnertypes-(deprecated)/partnertypecontroller_getpartnertyperuleaudittrails.md) ### Lists all the available Partner Direct Commissions Audit Trails for given Id. - [GET /api/partner-types/{partnerTypeId}/direct-commissions/{commissionId}/audit-trails](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partnertypes-(deprecated)/partnertypecontroller_getcommissionsaudittrailsforid.md) ### Lists Partner Indirect Commissions Audit Trails for given Id - [GET /api/partner-types/{partnerTypeId}/indirect-commissions/{commissionId}/audit-trails](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partnertypes-(deprecated)/partnertypecontroller_getaudittrailsforid.md) ### Assign Success Ladder Bonus - [POST /api/partner-types/{partnerTypeId}/success-ladder-bonuses](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partnertypes-(deprecated)/partnertypecontroller_assign.md) ### Gets the Success Ladder Bonus information for a given Partner Type. - [GET /api/partner-types/{partnerTypeId}/success-ladder-bonuses](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partnertypes-(deprecated)/partnertypecontroller_getslb.md) ### Patch for the Success Ladder Bonus information from a Partner Type - [PATCH /api/partner-types/{partnerTypeId}/success-ladder-bonuses](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partnertypes-(deprecated)/partnertypecontroller_patchslb.md) ### Adds HCO Commission for the Partner type. - [POST /api/partner-types/{partnerTypeId}/hco-commissions](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partnertypes-(deprecated)/partnertypecontroller_addhcocommission.md) ### Patches HCO Commission information by updating the items they were provided. - [PATCH /api/partner-types/{partnerTypeId}/hco-commissions](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partnertypes-(deprecated)/partnertypecontroller_patchhcocommission.md) ### Deletes HCO Commission information for the Partner type. - [DELETE /api/partner-types/{partnerTypeId}/hco-commissions](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partnertypes-(deprecated)/partnertypecontroller_deletehcocommission.md) ## SuccessLadderBonuses (Deprecated) ### Lists available Success Ladder Bonus Audit Trails for all. - [GET /api/success-ladder-bonuses/audit-trails](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/successladderbonuses-(deprecated)/successladderbonuscontroller_getaudittrailsforall.md) ### Adds Success Ladder Information. - [POST /api/success-ladder-bonuses](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/successladderbonuses-(deprecated)/successladderbonuscontroller_addsuccessladderbonus.md) ### Lists all the available Success Ladder Bonuses. - [GET /api/success-ladder-bonuses](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/successladderbonuses-(deprecated)/successladderbonuscontroller_getall.md) ### Patches the Success Ladder Bonus information by updating the items they were provided. - [PATCH /api/success-ladder-bonuses/{successLadderBonusId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/successladderbonuses-(deprecated)/successladderbonuscontroller_update.md) ### Lists available Success Ladder Bonus Audit Trails for given Id - [GET /api/success-ladder-bonuses/{successLadderBonusId}/audit-trails](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/successladderbonuses-(deprecated)/successladderbonuscontroller_getaudittrailsforid.md) ## PolicyGroups ### Lists available Policy Group Audit Trails for all the Policy Groups. - [GET /api/policy-groups/audit-trails](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/policygroups/policygroupscontroller_getaudittrailsforall.md) ### Patches the Policy Group information by updating the items. - [PATCH /api/policy-groups/{policyGroupId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/policygroups/policygroupscontroller_update.md) ### Get the Policy Group by Id. - [GET /api/policy-groups/{policyGroupId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/policygroups/policygroupscontroller_getbyid.md) ### Deletes the Policy Group information. - [DELETE /api/policy-groups/{policyGroupId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/policygroups/policygroupscontroller_deletebyid.md) ### Lists all the available Policy Group. - [GET /api/policy-groups](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/policygroups/policygroupscontroller_getall.md) ### Adds the Policy Group. - [POST /api/policy-groups](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/policygroups/policygroupscontroller_add.md) ### Deletes Policies from Policy Group. - [DELETE /api/policy-groups/{policyGroupId}/policies](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/policygroups/policygroupscontroller_deletepolicies.md) ### Adds Policies to Policy Group. - [POST /api/policy-groups/{policyGroupId}/policies](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/policygroups/policygroupscontroller_addpolicies.md) ### Archives the Policy Group information. - [POST /api/policy-groups/{policyGroupId}/archive](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/policygroups/policygroupscontroller_archive.md) ### Restores the Policy Group information. - [POST /api/policy-groups/{policyGroupId}/restore](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/policygroups/policygroupscontroller_restore.md) ### Lists all the available Policy Group Audit Trails for given Policy Group Id. - [GET /api/policy-groups/{policyGroupId}/audit-trails](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/policygroups/policygroupscontroller_getallaudittrailsbyid.md) ## Anelto Credentials ### Adds the Anelto Credentials for an Organization. - [POST /api/organizations/{organizationId}/anelto-credentials](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/anelto-credentials/aneltocredentialscontroller_addcredentials.md) ### Gets the Anelto Credentials for an Organization. - [GET /api/organizations/{organizationId}/anelto-credentials](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/anelto-credentials/aneltocredentialscontroller_getcredentials.md) ### Patches the Anelto Credentials for an Organization. - [PATCH /api/organizations/{organizationId}/anelto-credentials](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/anelto-credentials/aneltocredentialscontroller_updatecredentials.md) ### The purpose of this API is Re-Cache the Anelto Credentials in Redis - [POST /api/anelto-credentials/re-cache](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/anelto-credentials/aneltocredentialscontroller_recache.md): Permissions needed - organizations.admin ## Subscriber Devices ### Gets device logs by product type or provisioning attribute - [GET /api/subscriber-devices](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscriber-devices/subscriberdevicescontroller_getdevice.md) ### Retires a device - [PATCH /api/subscriber-devices/{deviceId}/retire](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscriber-devices/subscriberdevicescontroller_retiredevice.md) ### Gets subscribers associated with devices matching the provided provisioning attribute or product type - [GET /api/subscriber-devices/subscriber](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscriber-devices/subscriberdevicescontroller_getsubscriberbydevice.md) ## Client Credentials ### Adds the Client Credentials for an Organization. - [POST /api/organizations/{organizationId}/client-credentials](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/client-credentials/clientcredentialscontroller_addclientcredentials.md) ### Lists the Client Credentials Information for an Organization. - [GET /api/organizations/{organizationId}/client-credentials](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/client-credentials/clientcredentialscontroller_listcredentials.md) ### Gets the Client Credentials Information for an Organization. - [GET /api/organizations/{organizationId}/client-credentials/{clientId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/client-credentials/clientcredentialscontroller_getclientcredentials.md) ### Deletes the Client Credentials Information for an Organization. - [DELETE /api/organizations/{organizationId}/client-credentials/{clientId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/client-credentials/clientcredentialscontroller_deleteclientcredentials.md) ### ReSyncs the Client Credentials Information for an Organization in ACM. - [POST /api/organizations/{organizationId}/client-credentials/{clientId}/re-sync](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/client-credentials/clientcredentialscontroller_resyncclientcredentials.md) ### Archives the Client Credentials information. - [POST /api/organizations/{organizationId}/client-credentials/{clientId}/archive](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/client-credentials/clientcredentialscontroller_archivecc.md) ### Restores the Client Credential information. - [POST /api/organizations/{organizationId}/client-credentials/{clientId}/restore](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/client-credentials/clientcredentialscontroller_restorecc.md) ### Lists the Api Keys Information for an Organization. - [GET /api/organizations/{organizationId}/api-keys](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/client-credentials/apikeycredentialscontroller_listcredentials.md) ### Adds the ApiKey Credentials for an Organization. - [POST /api/organizations/{organizationId}/api-keys](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/client-credentials/apikeycredentialscontroller_addapikeycredentials.md) ### Gets the ApiKey Credentials Information for an Organization. - [GET /api/organizations/{organizationId}/api-keys/{apiKey}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/client-credentials/apikeycredentialscontroller_getapikeycredentials.md) ### Deletes the ApiKey Credentials Information for an Organization. - [DELETE /api/organizations/{organizationId}/api-keys/{apiKey}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/client-credentials/apikeycredentialscontroller_deleteapikeycredential.md) ### ReSyncs the ApiKey Credentials Information for an Organization in ACM. - [POST /api/organizations/{organizationId}/api-keys/{apiKey}/re-sync](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/client-credentials/apikeycredentialscontroller_resyncapikeycredentials.md) ### Archives the Api Key information. - [POST /api/organizations/{organizationId}/api-keys/{apiKey}/archive](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/client-credentials/apikeycredentialscontroller_archivecc.md) ### Restores the Api Key information. - [POST /api/organizations/{organizationId}/api-keys/{apiKey}/restore](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/client-credentials/apikeycredentialscontroller_restorecc.md) ### The purpose of this API is Re-Cache the Service Client Credentials in Redis - [POST /api/service-client-credentials/re-cache](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/client-credentials/serviceclientcredentialscontroller_recache.md): Permissions needed - organizations.admin ## Subscriber Status Change Histories ### Retrieve the status change history for a specific subscriber, listing the records in ascending order of changed_at timestamp. - [GET /api/organizations/{organizationId}/status-histories](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/subscriber-status-change-histories/subscriberstatuschangehistorycontroller_liststatuschangehistory.md): Permissions needed - subscribers.phi.read ## Partner-Types-V2 ### The purpose of this API is to add a new partner type - [POST /api/v2/partner-types](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-types-v2/partnertypecontroller_addpartnertype.md): Permissions needed - partners.admin ### This API will list all the given partner types. - [GET /api/v2/partner-types](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-types-v2/partnertypecontroller_list.md): Permissions needed - partners.read ### This API will get the partner type details - [GET /api/v2/partner-types/{partnerTypeId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-types-v2/partnertypecontroller_getbyid.md): Permissions needed - partners.read ### This API will delete the partner type. - [DELETE /api/v2/partner-types/{partnerTypeId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-types-v2/partnertypecontroller_delete.md): Permissions needed - partners.admin ### The purpose of this API is to update a specific partner type details. - [PATCH /api/v2/partner-types/{partnerTypeId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-types-v2/partnertypecontroller_update.md): Permissions needed - partners.admin ### This API activates a previously deactivated partner type. - [POST /api/v2/partner-types/{partnerTypeId}/activate](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-types-v2/partnertypecontroller_activate.md): Permissions needed - partners.admin ### This API deactivates a given partner type. - [POST /api/v2/partner-types/{partnerTypeId}/deactivate](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-types-v2/partnertypecontroller_deactivate.md): Permissions needed - partners.admin ### This API archives a specific partner type - [POST /api/v2/partner-types/{partnerTypeId}/archive](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-types-v2/partnertypecontroller_archive.md): Permissions needed - partners.admin ### This API restores a previously archived partner type. - [POST /api/v2/partner-types/{partnerTypeId}/restore](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-types-v2/partnertypecontroller_restore.md): Permissions needed - partners.admin ### This API will list all the ancestry for a given partner types (bottom-up) - Ancestry. - [GET /api/v2/partner-types/{partnerTypeId}/ancestries](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-types-v2/partnertypecontroller_ancestries.md): Permissions needed - partners.read ### This API will list all the hierarchy for a given partner types (top-to-bottom) - Hierarchy. - [GET /api/v2/partner-types/{partnerTypeId}/hierarchy](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-types-v2/partnertypecontroller_hierarchy.md): Permissions needed - partners.read ### This API serves two main purposes: 1. It recalculates the ancestry hierarchy for each node in the system, ensuring that all parent-child relationships are correctly established and updated. 2. After recalculating the ancestry, the API then synchronizes the updated partner type data with other microservices in the system, ensuring that the information is consistent across all services. - [POST /api/v2/partner-types/{partnerTypeId}/re-sync](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-types-v2/partnertypecontroller_resync.md): Permissions needed - partners.admin ### This API serves two main purposes: 1. It recalculates the ancestry hierarchy for each node in the system, ensuring that all parent-child relationships are correctly established and updated. 2. After recalculating the ancestry, the API then synchronizes the updated partner type data with other microservices in the system, ensuring that the information is consistent across all services. - [POST /api/v2/partner-types/re-sync-all](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-types-v2/partnertypecontroller_resyncall.md): Permissions needed - partners.admin ### audit trail. - [GET /api/v2/partner-types/{partnerTypeId}/audit-trails](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-types-v2/partnertypecontroller_getaudittrails.md): Permissions needed - partners.read ### audit trail. - [GET /api/v2/partner-type-rules/{partnerTypeId}/audit-trails](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-types-v2/partnertypecontroller_getaudittrailsforpartnertyperule.md): Permissions needed - partners.read ## Partner-Organizations ### The purpose of this API is to add a new partner - [POST /api/v2/partners](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-organizations/partnerv2controller_add.md): Permissions needed - organizations.billing.admin (This is for backward compatibility and will be deprecated soon) ,partners.create (This is the required permission to create a partner) ### This API will list all the given partners. - [GET /api/v2/partners](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-organizations/partnerv2controller_list.md): Permissions needed - partners.read ### This API will get the partner details - [GET /api/v2/partners/{partnerId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-organizations/partnerv2controller_getbyid.md): Permissions needed - partners.read ### This API will delete the partner. - [DELETE /api/v2/partners/{partnerId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-organizations/partnerv2controller_delete.md): Permissions needed - partners.admin ### This API updates a specific partner. - [PATCH /api/v2/partners/{partnerId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-organizations/partnerv2controller_update.md): Permissions needed - partners.admin ### This API activates a previously deactivated partner. - [POST /api/v2/partners/{partnerId}/activate](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-organizations/partnerv2controller_activate.md): Permissions needed - partners.admin ### This API deactivates a given partner. - [POST /api/v2/partners/{partnerId}/deactivate](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-organizations/partnerv2controller_deactivate.md): Permissions needed - partners.admin ### This API archives a specific partner - [POST /api/v2/partners/{partnerId}/archive](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-organizations/partnerv2controller_archive.md): Permissions needed - partners.admin ### This API restores a previously archived partner. - [POST /api/v2/partners/{partnerId}/restore](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-organizations/partnerv2controller_restore.md): Permissions needed - partners.admin ### The purpose of this API is to list all partners that can potentially be assigned as parents, based on the correct partner type - [GET /api/v2/partner-types/{partnerTypeId}/eligible-partners](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-organizations/partnerv2controller_listeligiblepartners.md): Permissions needed - partners.read ### This API will list all the ancestry or hierarchy tiers for a given partner based on the selected mode (ancestry or hierarchy). - [GET /api/v2/partners/{partnerId}/tiers](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-organizations/partnerv2controller_tiers.md): Permissions needed - partners.read ### The purpose of this API is to fetch the audit trails based on the partner Id. - [GET /api/v2/partners/{partnerId}/audit-trails](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-organizations/partnerv2controller_getaudittrails.md): Permissions needed - partners.read ### The purpose of this API is to perform CRM Sync. - [POST /api/v2/partners/{partnerId}/crm-sync](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-organizations/partnerv2controller_crmsync.md): Permissions needed - partners.admin,ecg-api-key ### The purpose of this API is to triggers a sync for the specified partner across dependent systems. - [POST /api/v2/partners/{partnerId}/re-sync](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-organizations/partnerv2controller_relaypartnersync.md): Permissions needed - partners.admin,ecg-api-key ### The purpose of this API is to triggers a sync for the specified partner across dependent systems. - [POST /api/v2/partners/re-sync-all](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-organizations/partnerv2controller_relaypartnersyncall.md): Permissions needed - partners.admin,ecg-api-key ### Syncs the vendor ID from Sage Intacct. - [POST /api/v2/partners/{partnerId}/vendorId-sync](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-organizations/partnerv2controller_syncvendorid.md) ## Bill-Vendors ### The purpose of this API is to add a new vendor in bill-com - [POST /api/v2/partners/{partnerId}/vendors](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/bill-vendors/vendorcontroller_addvendor.md): Permissions needed - partners.admin ### The purpose of this API is to update vendor bank account in bill-com - [PUT /api/v2/partners/{partnerId}/vendors/{vendorId}/bank-accounts](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/bill-vendors/vendorcontroller_updatebankaccount.md): Permissions needed - partners.admin ### The purpose of this API is to add a new vendor bank account in bill-com - [POST /api/v2/partners/{partnerId}/vendors/{vendorId}/bank-accounts](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/bill-vendors/vendorcontroller_addbankaccount.md): Permissions needed - partners.admin ### This API will delete the vendor bank account details from bill-com. - [DELETE /api/v2/partners/{partnerId}/vendors/{vendorId}/bank-accounts](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/bill-vendors/vendorcontroller_delete.md): Permissions needed - partners.admin ### This API archives a specific vendor - [POST /api/v2/partners/{partnerId}/vendors/{vendorId}/archive](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/bill-vendors/vendorcontroller_archive.md): Permissions needed - partners.admin ### This API restores a previously archived vendor. - [POST /api/v2/partners/{partnerId}/vendors/{vendorId}/restore](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/bill-vendors/vendorcontroller_restore.md): Permissions needed - partners.admin ### The purpose of this API is view Vendor Account Details - [GET /api/v2/partners/{partnerId}/vendors/{vendorId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/bill-vendors/vendorcontroller_getvendordata.md): Permissions needed - partners.admin ### Checks if the partner vendor is active and accessible in Bill.com - [GET /api/v2/partners/{partnerId}/check-status](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/bill-vendors/vendorcontroller_checkstatus.md): Permissions needed - partners.admin ## Partner-Activities ### The purpose of this API is to view Partner Activities - [GET /api/v2/partners/{partnerId}/activities](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-activities/partneractivitycontroller_listpartneractivity.md): Permissions needed - partners.read ## Teams ### Create a team. - [POST /organizations/{organizationId}/teams](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/teams/teamscontroller_createteam.md) ### List all teams in an organization. - [GET /organizations/{organizationId}/teams](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/teams/teamscontroller_listorgteams.md) ### Update a team. - [PATCH /organizations/{organizationId}/teams/{teamId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/teams/teamscontroller_updateteam.md) ### Get the team details. - [GET /organizations/{organizationId}/teams/{teamId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/teams/teamscontroller_getteamdetails.md) ### Add a member to a team. - [POST /organizations/{organizationId}/teams/{teamId}/members](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/teams/teamscontroller_addmember.md) ### Remove a member from a team. - [DELETE /organizations/{organizationId}/teams/{teamId}/members/{personId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/teams/teamscontroller_removemember.md) ### List all members of a team. - [GET /teams/{teamId}/members](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/teams/teamscontroller_listmembers.md) ### List all teams that a person is a member of. - [GET /persons/{personId}/teams](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/teams/teamscontroller_getpersonteams.md) ### Archive a team. - [POST /organizations/{organizationId}/teams/{teamId}/archive](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/teams/teamscontroller_archiveteam.md) ### Restore a team from being archived. - [POST /organizations/{organizationId}/teams/{teamId}/restore](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/teams/teamscontroller_restoreteam.md) ### Delete a team. - [DELETE /teams/{teamId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/teams/teamscontroller_deleteteam.md) ### Set a team to an inactive state. - [POST /organizations/{organizationId}/teams/{teamId}/deactivate](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/teams/teamscontroller_deactivateteam.md) ### Set a team to an active state. - [POST /organizations/{organizationId}/teams/{teamId}/activate](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/teams/teamscontroller_activateteam.md) ## Vendor Profiles ### V2 Version - This API provides the Vendor Profiles associated with a specific Organization. Credentials may originate from an Vendor Profile or the legacy organization-level credential system. The system intelligently determines the appropriate credential source and returns a secure reference to it. - [GET /api/organizations/{organizationId}/vendor-profiles](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/vendor-profiles/vendorprofilecontroller_getcredentials.md): Permissions needed - organizations.admin,ecg-api-key ### The purpose of this API is to add Vendor Profile - [POST /api/vendor-profiles](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/vendor-profiles/vendorprofilecontroller_add.md): Permissions needed - organizations.admin ### The purpose of this API is to view all Vendor Profiles - [GET /api/vendor-profiles](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/vendor-profiles/vendorprofilecontroller_list.md): Permissions needed - organizations.read ### The purpose of this API is to get Vendor Profile details by ID - [GET /api/vendor-profiles/{vendorProfileId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/vendor-profiles/vendorprofilecontroller_getbyid.md): Permissions needed - organizations.admin,ecg-api-key ### The purpose of this API is to update an existing Vendor Profile. Only source and description fields can be updated. - [PATCH /api/vendor-profiles/{vendorProfileId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/vendor-profiles/vendorprofilecontroller_update.md): Permissions needed - organizations.admin ### The purpose of this API is to re-sync Vendor Profile details in redis cache - [POST /api/vendor-profiles/{vendorProfileId}/re-sync](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/vendor-profiles/vendorprofilecontroller_resync.md): Permissions needed - organizations.admin,ecg-api-key ### The purpose of this API is to re-sync Vendor Profile details in redis cache - [POST /api/vendor-profiles/re-sync](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/vendor-profiles/vendorprofilecontroller_resyncall.md): Permissions needed - organizations.admin,ecg-api-key ### The purpose of this API is to activate an Vendor Profile - [POST /api/vendor-profiles/{vendorProfileId}/activate](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/vendor-profiles/vendorprofilecontroller_activate.md): Permissions needed - organizations.admin ### The purpose of this API is to deactivate an Vendor Profile - [POST /api/vendor-profiles/{vendorProfileId}/deactivate](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/vendor-profiles/vendorprofilecontroller_deactivate.md): Permissions needed - organizations.admin ### The purpose of this API is to get the organizations associated with a specific Vendor Profile - [GET /api/vendor-profiles/{vendorProfileId}/organizations](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/vendor-profiles/vendorprofilecontroller_getorganizations.md): Permissions needed - organizations.read