API

Check the liveness of the service

get

Responses

200Success

No content

get

/api/v1/health/liveness

HTTPcURLJavaScriptPython

GET /data/api/v1/health/liveness HTTP/1.1
Host: app.synkrato.com
Accept: */*

200Success

No content

Check the readiness of the service

get

Responses

200Success

No content

get

/api/v1/health/readiness

HTTPcURLJavaScriptPython

GET /data/api/v1/health/readiness HTTP/1.1
Host: app.synkrato.com
Accept: */*

200Success

No content

Get all master records

get

Path parameters

masterNamestringRequired

Query parameters

pageSizeinteger · min: 1 · max: 1000Required

pageinteger · min: 1Required

Responses

201Success

application/json

get

/api/v1/master-record/{masterName}

HTTPcURLJavaScriptPython

GET /data/api/v1/master-record/{masterName}?pageSize=1&page=1 HTTP/1.1
Host: app.synkrato.com
Accept: */*

201Success

[
  {
    "_id": "text",
    "createdBy": "text",
    "createdAt": "text",
    "updatedBy": "text",
    "updatedAt": "text",
    "tenantID": "text"
  }
]

Create or update a master record

post

Path parameters

masterNamestringRequired

Responses

201Success

post

/api/v1/master-record/{masterName}

HTTPcURLJavaScriptPython

POST /data/api/v1/master-record/{masterName} HTTP/1.1
Host: app.synkrato.com
Accept: */*

201Success

No content

Get all module records

get

Path parameters

moduleNamestringRequired

Query parameters

pageSizeinteger · min: 1 · max: 1000Required

pageinteger · min: 1Required

Responses

201Success

application/json

get

/api/v1/module-record/{moduleName}

HTTPcURLJavaScriptPython

GET /data/api/v1/module-record/{moduleName}?pageSize=1&page=1 HTTP/1.1
Host: app.synkrato.com
Accept: */*

201Success

[
  {
    "_id": "text",
    "createdBy": "text",
    "createdAt": "text",
    "updatedBy": "text",
    "updatedAt": "text",
    "tenantID": "text"
  }
]

Create or update a module record

post

Path parameters

moduleNamestringRequired

Query parameters

userNamestringRequired

Responses

201Success

post

/api/v1/module-record/{moduleName}

HTTPcURLJavaScriptPython

POST /data/api/v1/module-record/{moduleName}?userName=text HTTP/1.1
Host: app.synkrato.com
Accept: */*

201Success

No content

Create or update a sub-table record

post

Path parameters

tableIdstringRequired

Query parameters

moduleNamestringRequired

recordIdstringRequired

Responses

201Success

post

/api/v1/sub-table/{tableId}

HTTPcURLJavaScriptPython

POST /data/api/v1/sub-table/{tableId}?moduleName=text&recordId=text HTTP/1.1
Host: app.synkrato.com
Accept: */*

201Success

No content

Create a workflow

post

Path parameters

moduleNamestringRequired

Query parameters

userNamestringRequired

spaceNamestringRequired

actionNamestringRequired

Bodystring[]

application/json

string[]Optional

Responses

201Success

post

/api/v1/workflow/{moduleName}

HTTPcURLJavaScriptPython

POST /data/api/v1/workflow/{moduleName}?userName=text&spaceName=text&actionName=text HTTP/1.1
Host: app.synkrato.com
Content-Type: application/json
Accept: */*
Content-Length: 8

[
  "text"
]

201Success

No content

Create user access

post

Responses

201Success

post

/api/v1/user/user-access

HTTPcURLJavaScriptPython

POST /data/api/v1/user/user-access HTTP/1.1
Host: app.synkrato.com
Accept: */*

201Success

No content

Get user access

get

Query parameters

pageSizenumberRequired

pagenumberRequired

Responses

200Success

No content

get

/api/v1/user/user-access

HTTPcURLJavaScriptPython

GET /data/api/v1/user/user-access?pageSize=1&page=1 HTTP/1.1
Host: app.synkrato.com
Accept: */*

200Success

No content

Get user access by username

get

Query parameters

usernamestringRequired

Responses

200Success

No content

get

/api/v1/user/user-access/by-user

HTTPcURLJavaScriptPython

GET /data/api/v1/user/user-access/by-user?username=text HTTP/1.1
Host: app.synkrato.com
Accept: */*

200Success

No content

Get all groups

get

Query parameters

pagenumberRequired

pageSizenumberRequired

onlyProjectsGroupsbooleanRequired

Responses

200Success

No content

get

/api/v1/user/groups

HTTPcURLJavaScriptPython

GET /data/api/v1/user/groups?page=1&pageSize=1&onlyProjectsGroups=true HTTP/1.1
Host: app.synkrato.com
Accept: */*

200Success

No content

Activate users

patch

Bodystring[]

application/json

string[]Optional

Responses

200Success

No content

patch

/api/v1/user/activate-users

HTTPcURLJavaScriptPython

PATCH /data/api/v1/user/activate-users HTTP/1.1
Host: app.synkrato.com
Content-Type: application/json
Accept: */*
Content-Length: 8

[
  "text"
]

200Success

No content

Deactivate users

patch

Bodystring[]

application/json

string[]Optional

Responses

200Success

No content

patch

/api/v1/user/deactivate-users

HTTPcURLJavaScriptPython

PATCH /data/api/v1/user/deactivate-users HTTP/1.1
Host: app.synkrato.com
Content-Type: application/json
Accept: */*
Content-Length: 8

[
  "text"
]

200Success

No content

Remove users from company and/or project level groups

delete

Responses

200Success

No content

delete

/api/v1/user/users-access

HTTPcURLJavaScriptPython

DELETE /data/api/v1/user/users-access HTTP/1.1
Host: app.synkrato.com
Accept: */*

200Success

No content

Remove users from projects

delete

Responses

200Success

No content

delete

/api/v1/user/project-access

HTTPcURLJavaScriptPython

DELETE /data/api/v1/user/project-access HTTP/1.1
Host: app.synkrato.com
Accept: */*

200Success

No content