Libraries
/
Get library metadata

Introduction

The SyncroSim API is a RESTful API for interacting with SyncroSim Cloud to:

  • Manage organizations
  • Access libraries
  • Access maps
  • Perform zonal calculations

The API is usable via HTTP in any environment that supports HTTP requests.

For a step-by-step guide on the basics of using the API, see the Get started page.

Download OpenAPI description
index.json
index.yaml
Overview
SyncroSim API support

support@syncrosim.com

License

MIT

Languages
Servers
Mock server

https://apidocs.syncrosim.com/_mock/apis/

Production server

https://api.syncrosim.com/v1/

Organizations

Operations

Libraries

Operations

Get libraries of an organization

Request

Security
x-ss-api-key
curl -i -X GET \
  https://apidocs.syncrosim.com/_mock/apis/libs \
  -H 'x-ss-api-key: YOUR_API_KEY_HERE'

Responses

List of libraries in the organization

Bodyapplication/json
libraryNamestring

Name of the library

uploadUserstring

Name of user that uploaded the library

lastModifiedstring

Date the library was last modified

Response
application/json
{
  "libraryName": "string",
  "lastModified": "string"
}

Get library metadata

Request

Security
x-ss-api-key
Path
uploadUserstringrequired

Name of the library owner

libraryNamestringrequired

Name of the library

curl -i -X GET \
  'https://apidocs.syncrosim.com/_mock/apis/libs/user/{uploadUser}/{libraryName}/metadata' \
  -H 'x-ss-api-key: YOUR_API_KEY_HERE'

Responses

Metadata of the library

Bodyapplication/json
libraryNamestring

Name of library

libraryOwnerstring

Owner of the library

lastModifiedstring

Date the library was last modified

fileSizestring

Size of the file

packageNamestring

Name of SyncroSim package used in the library

packageVersionstring

Version of SyncroSim package used in the library

descriptionstring

Description of the library

Response
application/json
{
  "libraryName": "string",
  "libraryOwner": "string",
  "lastModified": "string",
  "fileSize": "string",
  "packageName": "string",
  "packageVersion": "string",
  "description": "string"
}

Get scenarios in a library

Request

Security
x-ss-api-key
Path
uploadUserstringrequired

Name of the library owner

libraryNamestringrequired

Name of the library

curl -i -X GET \
  'https://apidocs.syncrosim.com/_mock/apis/libs/user/{uploadUser}/{libraryName}/scenarios' \
  -H 'x-ss-api-key: YOUR_API_KEY_HERE'

Responses

List of scenarios in the library

Bodyapplication/json
scenarioIdinteger

Scenario ID number

parentIdinteger

ID number of the parent scenario

scenarioNamestring

Name of the scenario

isResultboolean

True if result, false if not a result (i.e., a parent scenario)

lastModifiedstring

Date the scenario was last modified

descriptionstring

Description of the scenario

Response
application/json
{
  "scenarioId": "integer",
  "parentId": "integer",
  "scenarioName": "string",
  "isResult": "boolean",
  "lastModified": "string",
  "description": "string"
}

Maps

OperationsWebhooks
Copyright 2025 © ApexRMS