Skip to main content
API docs by Redocly

Synkronus API (1.0.0)

Download OpenAPI specification:Download

Get the current custom app bundle manifest

Authorizations:
bearerAuth
header Parameters
x-api-version
string^\d+\.\d+\.\d+$
Example: 1.0.0

Optional API version header using semantic versioning (MAJOR.MINOR.PATCH)

Responses

Response samples

Content type
application/json
{
  • "files": [
    ],
  • "version": "string",
  • "generatedAt": "2019-08-24T14:15:22Z",
  • "hash": "string"
}

Get a specific file in the app bundle

Authorizations:
bearerAuth
path Parameters
path
required
string
query Parameters
preview
boolean
Default: false

If true, returns the file from the latest version including unreleased changes

header Parameters
if-none-match
string
x-api-version
string^\d+\.\d+\.\d+$
Example: 1.0.0

Optional API version header using semantic versioning (MAJOR.MINOR.PATCH)

Responses

Get a list of available app bundle versions

Authorizations:
bearerAuth
header Parameters
x-api-version
string^\d+\.\d+\.\d+$
Example: 1.0.0

Optional API version header using semantic versioning (MAJOR.MINOR.PATCH)

Responses

Response samples

Content type
application/json
{
  • "versions": [
    ]
}

Upload a new app bundle (admin only)

Authorizations:
bearerAuth
header Parameters
x-api-version
string^\d+\.\d+\.\d+$
Example: 1.0.0

Optional API version header using semantic versioning (MAJOR.MINOR.PATCH)

Request Body schema: multipart/form-data
required
bundle
string <binary>

ZIP file containing the new app bundle

Responses

Response samples

Content type
application/json
{
  • "message": "App bundle successfully pushed",
  • "manifest": {
    }
}

Switch to a specific app bundle version (admin only)

Authorizations:
bearerAuth
path Parameters
version
required
string

Version identifier to switch to

header Parameters
x-api-version
string^\d+\.\d+\.\d+$
Example: 1.0.0

Optional API version header using semantic versioning (MAJOR.MINOR.PATCH)

Responses

Response samples

Content type
application/json
{
  • "message": "Switched to app bundle version 20250507-123456"
}

Authenticate with the API

Obtain a JWT token by providing username and password

header Parameters
x-api-version
string^\d+\.\d+\.\d+$
Example: 1.0.0

Optional API version header using semantic versioning (MAJOR.MINOR.PATCH)

Request Body schema: application/json
required
username
required
string

User's username

password
required
string <password>

User's password

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "pa$$word"
}

Response samples

Content type
application/json
{
  • "token": "string",
  • "refreshToken": "string",
  • "expiresAt": 0
}

Refresh authentication token

Obtain a new JWT token using a refresh token

header Parameters
x-api-version
string^\d+\.\d+\.\d+$
Example: 1.0.0

Optional API version header using semantic versioning (MAJOR.MINOR.PATCH)

Request Body schema: application/json
required
refreshToken
required
string

Refresh token obtained from login or previous refresh

Responses

Request samples

Content type
application/json
{
  • "refreshToken": "string"
}

Response samples

Content type
application/json
{
  • "token": "string",
  • "refreshToken": "string",
  • "expiresAt": 0
}

Create a new user (admin only)

Create a new user with specified username, password, and role

Authorizations:
bearerAuth
header Parameters
x-api-version
string^\d+\.\d+\.\d+$
Example: 1.0.0

Optional API version header using semantic versioning (MAJOR.MINOR.PATCH)

Request Body schema: application/json
required
username
required
string

New user's username

password
required
string <password>

New user's password

role
required
string
Enum: "read-only" "read-write" "admin"

User's role

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "pa$$word",
  • "role": "read-only"
}

Response samples

Content type
application/json
{
  • "username": "string",
  • "role": "read-only",
  • "createdAt": "2019-08-24T14:15:22Z"
}

List all users (admin only)

Retrieve a list of all users in the system. Admin access required.

Authorizations:
bearerAuth
header Parameters
x-api-version
string^\d+\.\d+\.\d+$
Example: 1.0.0

Optional API version header using semantic versioning (MAJOR.MINOR.PATCH)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete a user (admin only)

Delete a user by username

Authorizations:
bearerAuth
path Parameters
username
required
string

Username of the user to delete

header Parameters
x-api-version
string^\d+\.\d+\.\d+$
Example: 1.0.0

Optional API version header using semantic versioning (MAJOR.MINOR.PATCH)

Responses

Response samples

Content type
application/json
{
  • "message": "User deleted successfully"
}

Reset a user's password (admin only)

Reset password for a specified user

Authorizations:
bearerAuth
header Parameters
x-api-version
string^\d+\.\d+\.\d+$
Example: 1.0.0

Optional API version header using semantic versioning (MAJOR.MINOR.PATCH)

Request Body schema: application/json
required
username
required
string

Username of the user whose password is being reset

newPassword
required
string <password>

New password for the user

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "newPassword": "pa$$word"
}

Response samples

Content type
application/json
{
  • "message": "Password reset successfully"
}

Change current user's password

Change password for the currently authenticated user

Authorizations:
bearerAuth
header Parameters
x-api-version
string^\d+\.\d+\.\d+$
Example: 1.0.0

Optional API version header using semantic versioning (MAJOR.MINOR.PATCH)

Request Body schema: application/json
required
currentPassword
required
string <password>

Current password for verification

newPassword
required
string <password>

New password to set

Responses

Request samples

Content type
application/json
{
  • "currentPassword": "pa$$word",
  • "newPassword": "pa$$word"
}

Response samples

Content type
application/json
{
  • "message": "Password changed successfully"
}

Pull updated records since last sync

Authorizations:
bearerAuth
query Parameters
schemaType
string

Filter by schemaType

limit
integer [ 1 .. 500 ]
Default: 50

Maximum number of records to return

page_token
string

Pagination token from previous response

header Parameters
x-api-version
string^\d+\.\d+\.\d+$
Example: 1.0.0

Optional API version header using semantic versioning (MAJOR.MINOR.PATCH)

Request Body schema: application/json
required
client_id
required
string

Unique identifier for the client

after_change_id
integer

Return records with change_id greater than this value

schema_types
Array of strings

Optional filter to specific schema types

Responses

Request samples

Content type
application/json
{
  • "client_id": "string",
  • "after_change_id": 0,
  • "schema_types": [
    ]
}

Response samples

Content type
application/json
{
  • "server_time": "2019-08-24T14:15:22Z",
  • "records": [
    ],
  • "change_cutoff": 0,
  • "next_page_token": "string",
  • "has_more": true
}

Push new or updated records to the server

Authorizations:
bearerAuth
header Parameters
x-api-version
string^\d+\.\d+\.\d+$
Example: 1.0.0

Optional API version header using semantic versioning (MAJOR.MINOR.PATCH)

Request Body schema: application/json
required
transmission_id
required
string <uuid>

Unique identifier for this transmission (for idempotency)

client_id
required
string

Unique identifier for the client

required
Array of objects (Record)

Array of records to push

Responses

Request samples

Content type
application/json
{
  • "transmission_id": "da08139c-7a56-4672-93e2-85353adf4d76",
  • "client_id": "string",
  • "records": [
    ]
}

Response samples

Content type
application/json
{
  • "server_time": "2019-08-24T14:15:22Z",
  • "success_count": 0,
  • "failed_records": [
    ],
  • "warnings": [
    ]
}