# 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)