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

Get members of an organization

Request

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

Responses

List of members in the organization

Bodyapplication/json
usernamestring

Username of the member

emailstring

Registered email of the member

firstNamestring

First name of the member

lastNamestring

Last name of the member

organizationstring

Organization the member belongs to

dateJoinedstring

Date the member joined

Response
application/json
{
  "username": "string",
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "organization": "string",
  "dateJoined": "string"
}

Invite a member to join an organization

Request

Security
x-ss-api-key
Bodyapplication/jsonrequired
usernamestring

Username to add to the organization

curl -i -X PUT \
  https://apidocs.syncrosim.com/_mock/apis/orgs/members \
  -H 'Content-Type: application/json' \
  -H 'x-ss-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "username": "string"
  }'

Responses

Request for member to join successfully sent

Remove a member from an organization

Request

Security
x-ss-api-key
Bodyapplication/jsonrequired
usernamestring

Username to remove from the organization

curl -i -X DELETE \
  https://apidocs.syncrosim.com/_mock/apis/orgs/members \
  -H 'Content-Type: application/json' \
  -H 'x-ss-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "username": "string"
  }'

Responses

Member removed successfully

Libraries

Operations

Maps

OperationsWebhooks
Copyright 2025 © ApexRMS