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

Meta

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

Get Organization

Request

Retrieve Organization

curl -i -X GET \
  https://api.synqly.com/v1/organization \
  -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" } }

Update Organization

Request

Update Organization

Bodyapplication/jsonrequired
idstring(Id)required
refresh_token_idstring(Id)required
organization_typestring(OrganizationType)required
Enum"root""standard"
fullnamestringrequired

Human friendly display name for this Organization

namestringrequired

Human-readable name for this resource

created_atstring(date-time)required

Time object was originally created

updated_atstring(date-time)required

Last time object was updated

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

Picture URL of the organization

optionsobject(OrganizationOptions)
curl -i -X PUT \
  https://api.synqly.com/v1/organization \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "string",
    "refresh_token_id": "string",
    "organization_type": "root",
    "fullname": "string",
    "contact": "string",
    "reply_to": "string",
    "picture": "string",
    "options": {
      "invite_duration": "string",
      "forgot_duration": "string",
      "password_duration": "string",
      "minimum_password_length": 0
    },
    "name": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }'

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" } }

Patch Organization

Request

Patch Organization

Bodyapplication/jsonrequiredArray [
opstring(PatchOp)required
Enum"add""copy""move""remove""replace""test"
pathstringrequired

The path to the field to update. The path is a JSON Pointer.

fromstring or null

The path to the field to copy from. This is required for copy and move operations.

valueany or null

The value to set the field to. This is required for add, replace and test operations.

]
curl -i -X PATCH \
  https://api.synqly.com/v1/organization \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "op": "add",
      "path": "string",
      "from": "string",
      "value": null
    }
  ]'

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" } }

Permissionset

Operations

Roles

Operations

Status

Operations

Sub Orgs

Operations

Tokens

Operations

Transforms

Operations