# Management API The Synqly Management APIs enable you to manage the resources within your Synqly organization, such as setting up Accounts for your customers and creating Integrations to connect your product to the different service Providers supported by Synqly. For more information see the [Synqly Overview](/guides/getting-started/overview). ## Servers Synqly ``` https://api.synqly.com ``` ## Security ### BearerAuth Type: http Scheme: bearer ## Download OpenAPI description [Management API](https://docs.synqly.com/_spec/api-reference/management.yaml) ## Accounts Accounts under your Organization are used to manage Integrations, Credentials, and other account specific resources. Accounts are secure containers and may be used to represent tenants in your system. Data is never shared across accounts. For more information on Accounts, see the [Synqly Overview](/guides/getting-started/overview). ### List Accounts - [GET /v1/accounts](https://docs.synqly.com/api-reference/management/accounts/accounts_list.md): Returns a list of all objects. For more information on Organizations and Accounts, refer to our Synqly Overview. ### Create Account - [POST /v1/accounts](https://docs.synqly.com/api-reference/management/accounts/accounts_create.md): Creates an object. For more information on Organizations and Accounts, refer to our Synqly Overview. ### Get Account - [GET /v1/accounts/{accountId}](https://docs.synqly.com/api-reference/management/accounts/accounts_get.md): Returns the object matching . For more information on Organizations and Accounts, refer to our Synqly Overview. ### Update Account - [PUT /v1/accounts/{accountId}](https://docs.synqly.com/api-reference/management/accounts/accounts_update.md): Updates the object matching . For more information on Organizations and Accounts, refer to our Synqly Overview. ### Patch Account - [PATCH /v1/accounts/{accountId}](https://docs.synqly.com/api-reference/management/accounts/accounts_patch.md): Patches the object matching . For more information on Organizations and Accounts, refer to our Synqly Overview. ### Delete Account - [DELETE /v1/accounts/{accountId}](https://docs.synqly.com/api-reference/management/accounts/accounts_delete.md): Deletes the matching . Deleting an also deletea all and belonging to the . ## Audit ### List Audit Events - [GET /v1/audit/organizations](https://docs.synqly.com/api-reference/management/audit/audit_list.md): Returns a list of all Synqly events for the . ## Auth ### Logon Organization - [POST /v1/auth/logon/{organizationId}](https://docs.synqly.com/api-reference/management/auth/auth_logon.md): Initiates a new session for the given member in specified Synqly organization. ### Change Member Password - [POST /v1/auth/change_password](https://docs.synqly.com/api-reference/management/auth/auth_change_password.md): Change member password. ### Logoff - [POST /v1/auth/logoff](https://docs.synqly.com/api-reference/management/auth/auth_logoff.md): Terminates the session identified by the given logon token. ## Bridges ### List Bridge Groups - [GET /v1/bridges/{accountId}](https://docs.synqly.com/api-reference/management/bridges/bridges_list.md): Returns a list of all objects that match the query params. ### Create Bridge Group - [POST /v1/bridges/{accountId}](https://docs.synqly.com/api-reference/management/bridges/bridges_create.md): Creates a with a unique identifier and authentication credentials. This allows for Bridge Agents to connect to Synqly. For more information on Bridges, refer to our Synqly Overview. ### Get Bridge Groups - [GET /v1/bridges/{accountId}/{bridgeId}](https://docs.synqly.com/api-reference/management/bridges/bridges_get.md): Returns the Bridge Group object matching . For more information on Bridges, refer to the Bridge Overview. ### Update Bridge Group - [PUT /v1/bridges/{accountId}/{bridgeId}](https://docs.synqly.com/api-reference/management/bridges/bridges_update.md): Updates the object matching . For more information on Bridges, refer to our Synqly Overview. ### Patch Bridge Group - [PATCH /v1/bridges/{accountId}/{bridgeId}](https://docs.synqly.com/api-reference/management/bridges/bridges_patch.md): Patches the object matching . For more information on Bridges, refer to our Synqly Overview. ### Delete Bridge Group - [DELETE /v1/bridges/{accountId}/{bridgeId}](https://docs.synqly.com/api-reference/management/bridges/bridges_delete.md): Deletes the matching . Deleting an also deletea all and belonging to the . ### Get Bridge Agent Statuses - [GET /v1/bridges/{accountId}/{bridgeId}/status](https://docs.synqly.com/api-reference/management/bridges/bridges_get_status.md): Returns the status and local configuration of running Bridges Agents in the Bridge Group . ## Capabilities ### List Connectors - [GET /v1/capabilities/connectors](https://docs.synqly.com/api-reference/management/capabilities/capabilities_list_connectors.md): Returns a list of all . ### List Providers - [GET /v1/capabilities/providers](https://docs.synqly.com/api-reference/management/capabilities/capabilities_list_providers.md): Returns a list of all Provider capabilities and their configurations. ### Get Provider - [GET /v1/capabilities/providers/{providerId}](https://docs.synqly.com/api-reference/management/capabilities/capabilities_get_provider.md): Returns the capabilities and configurations for a specific Provider type ## Credentials ### List Credentials - [GET /v1/credentials/{ownerId}](https://docs.synqly.com/api-reference/management/credentials/credentials_list.md): Returns a list of all objects belonging to the , , or , or matching . ### Create Credential - [POST /v1/credentials/{ownerId}](https://docs.synqly.com/api-reference/management/credentials/credentials_create.md): Creates a object in the , , or matching matching . A may only by used by a single , , or ; however, objects can be shared by multiple within an . ### Get Credential - [GET /v1/credentials/{ownerId}/{credentialId}](https://docs.synqly.com/api-reference/management/credentials/credentials_get.md): Returns the object matching where the belongs to the , , or matching . ### Update Credential - [PUT /v1/credentials/{ownerId}/{credentialId}](https://docs.synqly.com/api-reference/management/credentials/credentials_update.md): Updates the object matching , where the belongs to the , , or matching . ### Patch Credential - [PATCH /v1/credentials/{ownerId}/{credentialId}](https://docs.synqly.com/api-reference/management/credentials/credentials_patch.md): Patches the object matching , where the belongs to the , , or matching . ### Delete Credential - [DELETE /v1/credentials/{ownerId}/{credentialId}](https://docs.synqly.com/api-reference/management/credentials/credentials_delete.md): Deletes the object matching , where the belongs to the , , or matching . ### Lookup Credential - [GET /v1/credentials/lookup/{credentialId}](https://docs.synqly.com/api-reference/management/credentials/credentials_lookup.md): Returns the object matching . ## Integration Points An Integration Point describes a class of Integrations, and lets you describe names, allowed providers and other configuration that should apply to integrations associated with the Integration Point. While an Integration can be created without associating it with an Integration Point, some Synqly features require the use of Integration Points, such as: * [Connect UI](https://synqly.com/synqly-connector-ui/) * Validating allowed providers * Custom data mapping (coming soon) Integration Points belong to the Organization, and can be associated with Integrations belonging to different Accounts. For more information on Integration Points, see the [Synqly Overview](/guides/getting-started/overview). ### List Integration Points - [GET /v1/integration-points](https://docs.synqly.com/api-reference/management/integrationpoints/integrationpoints_list.md): Returns a list of all objects. ### Create Integration Point - [POST /v1/integration-points](https://docs.synqly.com/api-reference/management/integrationpoints/integrationpoints_create.md): Create a object. ### Get Integration Point - [GET /v1/integration-points/{integrationPointId}](https://docs.synqly.com/api-reference/management/integrationpoints/integrationpoints_get.md): Returns the object matching . ### Update Integration Point - [PUT /v1/integration-points/{integrationPointId}](https://docs.synqly.com/api-reference/management/integrationpoints/integrationpoints_update.md): Updates the object matching . ### Patch Integration Point - [PATCH /v1/integration-points/{integrationPointId}](https://docs.synqly.com/api-reference/management/integrationpoints/integrationpoints_patch.md): Patches the object matching . ### Delete Integration Point - [DELETE /v1/integration-points/{integrationPointId}](https://docs.synqly.com/api-reference/management/integrationpoints/integrationpoints_delete.md): Deletes the object matching . ## Integrations An Integration represents the connection to a specific Provider. Once configured, an Integration enables interaction with the target Provider via our unified and normalized [Connector APIs](/api-reference/connectors). Each Integration belongs to an [Account](/api-reference/management/accounts) and may be associated with an [Integration Point](/api-reference/management/integrationpoints) to provide additional features and configuration. For more information on Integrations, see the [Synqly Overview](/guides/getting-started/overview). ### List Integrations - [GET /v1/integrations](https://docs.synqly.com/api-reference/management/integrations/integrations_list.md): Returns a list of all objects that match the query params. ### List Account Integrations - [GET /v1/integrations/{accountId}](https://docs.synqly.com/api-reference/management/integrations/integrations_list_account.md): Returns a list of all objects belonging to the matching . ### Create Integration - [POST /v1/integrations/{accountId}](https://docs.synqly.com/api-reference/management/integrations/integrations_create.md): Creates an object belonging to the matching . Configures the with the Provider specified in the request. Returns an token for use with APIs. ### Get Integration - [GET /v1/integrations/{accountId}/{integrationId}](https://docs.synqly.com/api-reference/management/integrations/integrations_get.md): Returns the object matching where the belongs to the matching . ### Update Integration - [PUT /v1/integrations/{accountId}/{integrationId}](https://docs.synqly.com/api-reference/management/integrations/integrations_update.md): Updates the object matching , where the belongs to the matching . ### Patch Integration - [PATCH /v1/integrations/{accountId}/{integrationId}](https://docs.synqly.com/api-reference/management/integrations/integrations_patch.md): Patches the object matching , where the belongs to the matching . ### Delete Integration - [DELETE /v1/integrations/{accountId}/{integrationId}](https://docs.synqly.com/api-reference/management/integrations/integrations_delete.md): Deletes the object matching IntegrationAccount{accountId}Integration` also deletes any tokens that belong to it. ### Verify Integration - [POST /v1/integrations/{accountId}/verify](https://docs.synqly.com/api-reference/management/integrations/integrations_verify.md): Verifies an ephemeral and provider configuration and tests the authentication and provider connectivity. The provider config credential IDs can utilize persistent IDs or use "#/n" reference IDs; where (n) is the zero based offset in the optional credentials list. ## Mappings (In Development) {% admonition type="warning" name="In Development" %} This feature is actively being developed. Breaking changes should be expected. Please contact us before using this feature. {% /admonition %} ### List Mappings - [GET /v1/mappings](https://docs.synqly.com/api-reference/management/mappings/mappings_list.md): {% admonition type="warning" name="In Development" %} This operation is actively being developed. Breaking changes should be expected. Please contact us before using this operation. {% /admonition %} Returns a list of all objects. ### Create Mapping - [POST /v1/mappings](https://docs.synqly.com/api-reference/management/mappings/mappings_create.md): {% admonition type="warning" name="In Development" %} This operation is actively being developed. Breaking changes should be expected. Please contact us before using this operation. {% /admonition %} Creates an mapping object. ### Get Mapping - [GET /v1/mappings/{mappingId}](https://docs.synqly.com/api-reference/management/mappings/mappings_get.md): {% admonition type="warning" name="In Development" %} This operation is actively being developed. Breaking changes should be expected. Please contact us before using this operation. {% /admonition %} Returns the object matching . This response will include the full field. ### Update Mapping - [PUT /v1/mappings/{mappingId}](https://docs.synqly.com/api-reference/management/mappings/mappings_update.md): {% admonition type="warning" name="In Development" %} This operation is actively being developed. Breaking changes should be expected. Please contact us before using this operation. {% /admonition %} Updates the mapping object matching . ### Patch Mapping - [PATCH /v1/mappings/{mappingId}](https://docs.synqly.com/api-reference/management/mappings/mappings_patch.md): {% admonition type="warning" name="In Development" %} This operation is actively being developed. Breaking changes should be expected. Please contact us before using this operation. {% /admonition %} Patches the mapping object matching . ### Delete Mapping - [DELETE /v1/mappings/{mappingId}](https://docs.synqly.com/api-reference/management/mappings/mappings_delete.md): {% admonition type="warning" name="In Development" %} This operation is actively being developed. Breaking changes should be expected. Please contact us before using this operation. {% /admonition %} Deletes the mapping object matching . ### Apply mapping transforms against the JSON input. - [POST /v1/mappings/apply](https://docs.synqly.com/api-reference/management/mappings/mappings_apply.md): {% admonition type="warning" name="In Development" %} This operation is actively being developed. Breaking changes should be expected. Please contact us before using this operation. {% /admonition %} Apply a list of mapping transforms against the JSON input. ## Members ### List Members - [GET /v1/members](https://docs.synqly.com/api-reference/management/members/members_list.md): List all members ### Create Member - [POST /v1/members](https://docs.synqly.com/api-reference/management/members/members_create.md): Add a new member for this Organization. ### Get Member - [GET /v1/members/{memberId}](https://docs.synqly.com/api-reference/management/members/members_get.md): Retrieve a Member by ID ### Update Member - [PUT /v1/members/{memberId}](https://docs.synqly.com/api-reference/management/members/members_update.md): Update a Member by ID ### Patch Member - [PATCH /v1/members/{memberId}](https://docs.synqly.com/api-reference/management/members/members_patch.md): Update a Member by ID ### Delete Member - [DELETE /v1/members/{memberId}](https://docs.synqly.com/api-reference/management/members/members_delete.md): Delete a Member by ID. Also deletes all Tokens for the Member. ## Meta ### Get Management OpenAPI Spec - [GET /v1/meta/openapi/management](https://docs.synqly.com/api-reference/management/meta/meta_managementopenapispec.md): Retrieve the OpenAPI spec for the Management API ### Get Engine OpenAPI Spec - [GET /v1/meta/openapi/engine](https://docs.synqly.com/api-reference/management/meta/meta_engineopenapispec.md): Retrieve the OpenAPI spec for the Engine APIs ## Operations (In Development) {% admonition type="warning" name="In Development" %} This feature is actively being developed. Breaking changes should be expected. Please contact us before using this feature. {% /admonition %} ### List Asynchronous Operations - [GET /v1/jobs](https://docs.synqly.com/api-reference/management/operations/operations_list.md): {% admonition type="warning" name="In Development" %} This operation is actively being developed. Breaking changes should be expected. Please contact us before using this operation. {% /admonition %} Returns a list of all objects. ## Organization Webhooks ### List Organization Webhooks - [GET /v1/organization/webhooks](https://docs.synqly.com/api-reference/management/organizationwebhooks/organizationwebhooks_list.md): List webhooks for the organization ### Create Organization Webhook - [POST /v1/organization/webhooks](https://docs.synqly.com/api-reference/management/organizationwebhooks/organizationwebhooks_create.md): Create a new webhook for the organization ### Get Organization Webhook - [GET /v1/organization/webhooks/{webhookId}](https://docs.synqly.com/api-reference/management/organizationwebhooks/organizationwebhooks_get.md): Returns the object matching . ### Update Organization Webhook - [PUT /v1/organization/webhooks/{webhookId}](https://docs.synqly.com/api-reference/management/organizationwebhooks/organizationwebhooks_update.md): Updates the object matching . For more information on Organizations and Webhooks, refer to our Synqly Overview. ### Patch Organization Webhook - [PATCH /v1/organization/webhooks/{webhookId}](https://docs.synqly.com/api-reference/management/organizationwebhooks/organizationwebhooks_patch.md): Patches the object matching . For more information on Organizations and Webhooks, refer to our Synqly Overview. ### Delete Organization Webhook - [DELETE /v1/organization/webhooks/{webhookId}](https://docs.synqly.com/api-reference/management/organizationwebhooks/organizationwebhooks_delete.md): Delete a webhook for the organization ## Organization ### Get Organization - [GET /v1/organization](https://docs.synqly.com/api-reference/management/organization/organization_get.md): Retrieve Organization ### Update Organization - [PUT /v1/organization](https://docs.synqly.com/api-reference/management/organization/organization_update.md): Update Organization ### Patch Organization - [PATCH /v1/organization](https://docs.synqly.com/api-reference/management/organization/organization_patch.md): Patch Organization ## Permissionset ### List PermissionSets - [GET /v1/permissionsets](https://docs.synqly.com/api-reference/management/permissionset/permissionset_list.md): Returns a list of all objects that match the query params. ### Get PermissionSet - [GET /v1/permissionsets/{permissionsetId}](https://docs.synqly.com/api-reference/management/permissionset/permissionset_get.md): Returns the object matching . For more information on PermissionSets, refer to our Synqly Overview. ## Roles ### List Roles - [GET /v1/roles](https://docs.synqly.com/api-reference/management/roles/roles_list.md): Returns a list of all objects that match the query params. ### Create Role - [POST /v1/roles](https://docs.synqly.com/api-reference/management/roles/roles_create.md): Creates an object. For more information on Roles, refer to our Synqly Overview. ### Get Role - [GET /v1/roles/{roleId}](https://docs.synqly.com/api-reference/management/roles/roles_get.md): Returns the object matching . For more information on Roles, refer to our Synqly Overview. ### Update Role - [PUT /v1/roles/{roleId}](https://docs.synqly.com/api-reference/management/roles/roles_update.md): Updates the object matching . For more information on Roles, refer to our Synqly Overview. ### Patch Role - [PATCH /v1/roles/{roleId}](https://docs.synqly.com/api-reference/management/roles/roles_patch.md): Patches the object matching . For more information on Roles, refer to our Synqly Overview. ### Delete Role - [DELETE /v1/roles/{roleId}](https://docs.synqly.com/api-reference/management/roles/roles_delete.md): Deletes the matching . Deleting an also deletea all and belonging to the . ## Status ### List Status - [GET /v1/status](https://docs.synqly.com/api-reference/management/status/status_list.md): Returns all matching objects. ### Get Status - [GET /v1/status/{accountId}/{integrationId}](https://docs.synqly.com/api-reference/management/status/status_get.md): Returns the integration object. ### Reset Status - [PUT /v1/status/{accountId}/{integrationId}](https://docs.synqly.com/api-reference/management/status/status_reset.md): Resets the integration object. ### List Status Events - [GET /v1/status/{accountId}/{integrationId}/events](https://docs.synqly.com/api-reference/management/status/status_list_events.md): Returns integration object list of objects. ### Get Status Timeseries - [GET /v1/status/timeseries](https://docs.synqly.com/api-reference/management/status/status_get_timeseries.md): Returns organization last hour usage timeseries. ### Get Integration Timeseries - [GET /v1/status/{accountId}/{integrationId}/timeseries](https://docs.synqly.com/api-reference/management/status/status_get_integration_timeseries.md): Returns organization last hour usage timeseries. ## Sub Orgs ### List Sub-Organizations - [GET /v1/suborgs](https://docs.synqly.com/api-reference/management/suborgs/suborgs_list.md): List all organizations ### Create Sub-Organization - [POST /v1/suborgs](https://docs.synqly.com/api-reference/management/suborgs/suborgs_create.md): Add a new organization. ### Get Sub-Organization - [GET /v1/suborgs/{organizationId}](https://docs.synqly.com/api-reference/management/suborgs/suborgs_get.md): Retrieve an Organization by ID ### Delete Sub-Organization - [DELETE /v1/suborgs/{organizationId}](https://docs.synqly.com/api-reference/management/suborgs/suborgs_delete.md): Delete a Organization by ID. Also deletes ## Tokens ### Create Organization Token - [POST /v1/tokens](https://docs.synqly.com/api-reference/management/tokens/tokens_create_token.md): Create an adhoc organization token restricted to specified resources and permission set. Tokens can only be reduced in scope, never expanded. Permissions are inherited from the token used to call this API. Permissions assigned to the new token will not be persisted, this is not a way to create roles. ### List Refresh Tokens - [GET /v1/tokens](https://docs.synqly.com/api-reference/management/tokens/tokens_list.md): Returns a list of all objects belonging to the Authorization Bearer token. For more infromation on Tokens, refer to Authentication. ### Create Integration Token - [POST /v1/tokens/{accountId}/{integrationId}](https://docs.synqly.com/api-reference/management/tokens/tokens_create_integration_token.md): Create an adhoc integration token restricted to a single integration. The token used to call this API must have the necessary permissions to create tokens and have access to the account and integration IDs. Permissions may not be escalated, so any operation that the invocation token does not have access to cannot be granted. ### Create Synqly Integrations Token - [POST /v1/tokens/synqly-integrations](https://docs.synqly.com/api-reference/management/tokens/tokens_create_synqly_integrations_token.md): {% admonition type="warning" name="In Development" %} This operation is actively being developed. Breaking changes should be expected. Please contact us before using this operation. {% /admonition %} Create a token for managing Synqly-specific integrations. This token can be used with the integration APIs to manage integrations for Synqly-specific integrations, such as status events exports and async operations. See the Synqly Integrations documentation for more information. ### Delete Adhoc Refresh Token - [DELETE /v1/tokens/{refreshTokenId}](https://docs.synqly.com/api-reference/management/tokens/tokens_delete.md): Deletes the Refresh Token with id . This immediately invalidates both the primary and secondary token pairs. ### Get Refresh Token - [GET /v1/tokens/{refreshTokenId}/info](https://docs.synqly.com/api-reference/management/tokens/tokens_get.md): Returns the object matching . For more information on Tokens, refer to Authentication. ### Reset Refresh Token - [PUT /v1/tokens/{ownerId}/{refreshTokenId}/reset](https://docs.synqly.com/api-reference/management/tokens/tokens_reset.md): This API can be used to reset or . Resets the specified and expiration time, removes the secondary, and resets access and refresh tokens for the object matching where is an or . An token with permissions can be used to perform this operation. ### Refresh Token Pair - [PUT /v1/tokens/{refreshTokenId}/refresh](https://docs.synqly.com/api-reference/management/tokens/tokens_refresh.md): Creates a new primary object, setting the secondary to the previous primary value. Call to remove this secondary backup once the new primary has been deployed. ### Remove Secondary Token - [DELETE /v1/tokens/{refreshTokenId}/secondary](https://docs.synqly.com/api-reference/management/tokens/tokens_remove_secondary.md): Deletes the secondary for the object matching .