API Reference

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.

Download OpenAPI description

management.json

management.yaml

Servers

Synqly

https://api.synqly.com/

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.

Operations

Audit

Operations

Auth

Operations

Bridges

Operations

Capabilities

Operations

Credentials

Operations

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
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.

Operations

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.

Each Integration belongs to an Account and may be associated with an Integration Point to provide additional features and configuration.

For more information on Integrations, see the Synqly Overview.

Operations

Members

Operations

Operations (In Development)

In Development

This feature is actively being developed. Breaking changes should be expected.

Please contact us before using this feature.

Operations

Organization Webhooks

Operations

Organization

Operations

Permissionset

Operations

Roles

Operations

Status

Operations

Sub Orgs

Operations

List Sub-Organizations

Request

List all organizations

curl -i -X GET \
  https://api.synqly.com/v1/suborgs \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

resultArray of objects(Organization)required

result[].idstring(Id)required

result[].refresh_token_idstring(Id)required

result[].organization_typestring(OrganizationType)required

Enum"root""standard"

result[].fullnamestringrequired

Human friendly display name for this Organization

result[].namestringrequired

Human-readable name for this resource

result[].created_atstring(date-time)required

Time object was originally created

result[].updated_atstring(date-time)required

Last time object was updated

result[].contactstring or null

Organization email address

result[].reply_tostring or null

Reply-to email address, used for SMTP emails. Defaults to no-reply@synqly.com

result[].picturestring or null

Picture URL of the organization

result[].optionsobject(OrganizationOptions)

Response

application/json

{
  "result": [
    { … }
  ]
}

Create Sub-Organization

Request

Add a new organization.

Bodyapplication/jsonrequired

namestring or null

Unique short name for this Organization (lowercase [a-z0-9_-], can be used in URLs). Used for case insensitive duplicate name detection and default sort order. Defaults to OrganizationId if both name and fullname are not specified.

fullnamestring or null

Human friendly display name for this Organization, will auto-generate 'name' field (if 'name' is not specified). Defaults to the same value as the 'name' field if not specified.

contactstring or null

Organization email address

reply_tostring or null

Reply-to email address, used for SMTP emails. Defaults to no-reply@synqly.com

picturestring or null

URL of the organization

memberobject(CreateMemberRequest)

curl -i -X POST \
  https://api.synqly.com/v1/suborgs \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "fullname": "string",
    "contact": "string",
    "reply_to": "string",
    "picture": "string",
    "member": {
      "name": "string",
      "fullname": "string",
      "nickname": "string",
      "picture": "string",
      "secret": "string",
      "role_binding": [
        "string"
      ],
      "options": {
        "ttl": "string",
        "options": [
          "disabled"
        ],
        "token_ttl": "string"
      }
    }
  }'

Responses

Bodyapplication/json

resultobject(CreateOrganizationResponseResult)required

result.organizationobject(Organization)required

result.organization.idstring(Id)required

result.organization.refresh_token_idstring(Id)required

result.organization.organization_typestring(OrganizationType)required

Enum"root""standard"

result.organization.fullnamestringrequired

Human friendly display name for this Organization

result.organization.namestringrequired

Human-readable name for this resource

result.organization.created_atstring(date-time)required

Time object was originally created

result.organization.updated_atstring(date-time)required

Last time object was updated

result.organization.contactstring or null

Organization email address

result.organization.reply_tostring or null

Reply-to email address, used for SMTP emails. Defaults to no-reply@synqly.com

result.organization.picturestring or null

Picture URL of the organization

result.organization.optionsobject(OrganizationOptions)

result.tokenobject(TokenPair)required

result.token.accessobject(Token)required

result.token.access.secretstringrequired

Secret value for the token; used for authentication when making requests.

result.token.access.expiresstring(date-time)required

Time when this token expires and can no longer be used again.

result.token.access.permissionsobject(Permission)required

result.token.access.permissions.resource_idstring(Id)required

result.token.access.permissions.resource_typestringrequired

Type of the resource that this permission grants access to. Must be one of the following: "organization, "integration"

result.token.access.permissions.parent_idstring(Id)required

result.token.access.permissions.idstring(Id)required

result.token.access.permissions.organization_idstring(Id)required

result.token.access.permissions.member_idstring(Id)required

result.token.access.permissions.role_bindingArray of strings or null(RoleName)

Roles granted to this token.

result.token.access.permissions.adhoc_roleobject(AdhocRole)

result.token.access.permissions.root_organization_idstring(Id)

result.token.refreshobject(Token)required

result.token.refresh.secretstringrequired

Secret value for the token; used for authentication when making requests.

result.token.refresh.expiresstring(date-time)required

Time when this token expires and can no longer be used again.

result.token.refresh.permissionsobject(Permission)required

result.token.refresh.permissions.resource_idstring(Id)required

result.token.refresh.permissions.resource_typestringrequired

Type of the resource that this permission grants access to. Must be one of the following: "organization, "integration"

result.token.refresh.permissions.parent_idstring(Id)required

result.token.refresh.permissions.idstring(Id)required

result.token.refresh.permissions.organization_idstring(Id)required

result.token.refresh.permissions.member_idstring(Id)required

result.token.refresh.permissions.role_bindingArray of strings or null(RoleName)

Roles granted to this token.

result.token.refresh.permissions.adhoc_roleobject(AdhocRole)

result.token.refresh.permissions.root_organization_idstring(Id)

result.memberobject(Member)

Response

application/json

{
  "result": {
    "member": { … },
    "organization": { … },
    "token": { … }
  }
}

Get Sub-Organization

Request

Retrieve an Organization by ID

Path

organizationIdstring(Id)required

curl -i -X GET \
  'https://api.synqly.com/v1/suborgs/{organizationId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

resultobject(Organization)required

result.idstring(Id)required

result.refresh_token_idstring(Id)required

result.organization_typestring(OrganizationType)required

Enum"root""standard"

result.fullnamestringrequired

Human friendly display name for this Organization

result.namestringrequired

Human-readable name for this resource

result.created_atstring(date-time)required

Time object was originally created

result.updated_atstring(date-time)required

Last time object was updated

result.contactstring or null

Organization email address

result.reply_tostring or null

Reply-to email address, used for SMTP emails. Defaults to no-reply@synqly.com

result.picturestring or null

Picture URL of the organization

result.optionsobject(OrganizationOptions)

Response

application/json

{
  "result": {
    "id": "string",
    "refresh_token_id": "string",
    "organization_type": "root",
    "fullname": "string",
    "contact": "string",
    "reply_to": "string",
    "picture": "string",
    "options": { … },
    "name": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

Delete Sub-Organization

Request

Delete a Organization by ID. Also deletes

Path

organizationIdstring(Id)required

curl -i -X DELETE \
  'https://api.synqly.com/v1/suborgs/{organizationId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Response

No content

Tokens

Operations

Transforms

Operations

Management API

Accounts

Audit

Auth

Bridges

Capabilities

Credentials

Integration Points

Integrations

Members

Meta

Operations (In Development)

Organization Webhooks

Organization

Permissionset

Roles

Status

Sub Orgs

List Sub-Organizations

Request

Responses

Was this helpful?

Create Sub-Organization

Request

Responses

Was this helpful?

Get Sub-Organization

Request

Responses

Was this helpful?

Delete Sub-Organization

Request

Responses

Was this helpful?

Tokens

Transforms

Management API

Accounts

Audit

Auth

Bridges

Capabilities

Credentials

Integration Points

Integrations

Members

Meta

Operations (In Development)

Organization Webhooks

Organization

Permissionset

Roles

Status

Sub Orgs

List Sub-Organizations

Request

Responses

Was this helpful?

Create Sub-Organization

RequestExpand all

Responses

Was this helpful?

Get Sub-Organization

Request

Responses

Was this helpful?

Delete Sub-Organization

Request

Responses

Was this helpful?

Tokens

Transforms

Request