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

AlphaList Asynchronous Operations

Request

In Development

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

Please contact us before using this operation.

Returns a list of all Asynchronous Operations objects.

Query
limitinteger or null

Number of Asynchronous Operations objects to return in this page. Defaults to 100.

start_afterstring or null

Return Asynchronous Operations objects starting after this name.

orderArray of strings or null

Select a field to order the results by. Defaults to id. To control the direction of the sorting, append [asc] or [desc] to the field id. For example, id[desc] will sort the results by id in descending order. The ordering defaults to asc if not specified. May be used multiple times to order by multiple fields, and the ordering is applied in the order the fields are specified.

filterArray of strings or null

Filter results by this query. For more information on filtering, refer to our Filtering Guide. Defaults to no filter. If used more than once, the queries are ANDed together.

curl -i -X GET \
  'https://api.synqly.com/v1/jobs?filter=string&limit=0&order=string&start_after=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
resultArray of objects(Operation)required
result[].​idstring(Id)required
result[].​created_atstring(date-time)required

Time object was originally created

result[].​updated_atstring(date-time)required

Last time object was updated

result[].​account_idstring(Id)required
result[].​integration_idstring(Id)required
result[].​operationstringrequired

Name of the operation that will be run for this operation.

result[].​inputobject(OperationInput)required
result[].​input.​filtersArray of strings or null

Limit the number of results returned by the operation. If not specified, the operation will return all results.

result[].​input.​limitinteger or null

Limit query results by these filters.

result[].​statusstring(OperationStatus)required
Enum"SCHEDULED""PROCESSING""CANCELLED""COMPLETE"
result[].​cpu_timeinteger(int64)required

Cpu time in microseconds

result[].​in_bytesinteger(int64)required

Number of bytes sent to sink integration

result[].​scheduleobject(OperationSchedule)
result[].​errorsArray of objects or null(OperationError)

Errors that occurred during the operation

Response
application/json
{ "result": [ {} ] }

Organization Webhooks

Operations

Organization

Operations

Permissionset

Operations

Roles

Operations

Status

Operations

Sub Orgs

Operations

Tokens

Operations

Transforms

Operations