System Surveyor

Design and manage physical spaces in System Surveyor.

Connections

API Key {#ssvapikeyconnection}

Authenticate requests using an API key.

Input	Comments	Default
Base URL	The base URL for the System Surveyor API environment.	https://openapi.systemsurveyor.com
API Key	The enterprise access token generated by an account administrator.

Basic Authentication {#ssvtokenconnection}

Authenticate using email and password.

Input	Comments	Default
Base URL	The base URL for the System Surveyor API environment.	https://openapi.systemsurveyor.com
Email	The email address used to authenticate with System Surveyor.
Password	The password for the System Surveyor account.

Triggers

New and Updated Sites {#neworupdatedsitestrigger}

Checks for new and updated sites in System Surveyor on a configured schedule.

Input	Comments	Default
Connection	The System Surveyor connection to use.

Actions

Get Element Profile Accessories {#getelementprofileaccessories}

Retrieve accessories associated with a specific element profile.

Input	Comments	Default
Connection	The System Surveyor connection to use.
Team ID	The unique identifier for the team in System Surveyor.
Element ID	The numeric identifier of the element.

Get Site Contacts {#getsitecontacts}

Retrieve contacts associated with a specific site.

Input	Comments	Default
Connection	The System Surveyor connection to use.
Site ID	The unique identifier (UUID) of the site.

Get Site Info {#getsiteinfo}

Retrieve information about a specific site.

Input	Comments	Default
Connection	The System Surveyor connection to use.
Site ID	The unique identifier (UUID) of the site.

Get Sites and Folders {#getsitesandfolders}

Retrieve a list of sites and folders accessible to the user.

Input	Comments	Default
Connection	The System Surveyor connection to use.
Fetch All	When true, automatically fetches all pages of results using pagination. When false, returns a single page based on the Page Number and Page Size inputs.	false
Page Number	The 1-based page number to retrieve. Used when Fetch All is disabled.
Page Size	The number of records per page. Used when Fetch All is disabled.
Modified After	Filters results to only include records modified after this Unix UTC epoch timestamp. Leave blank to retrieve all records.

Get Survey {#getsurvey}

Retrieve information about a specific survey.

Input	Comments	Default
Connection	The System Surveyor connection to use.
Site ID	The unique identifier (UUID) of the site.
Survey ID	The unique identifier (UUID) of the survey.

Get Team Members {#getteammembers}

Retrieve all members of a specific team.

Input	Comments	Default
Connection	The System Surveyor connection to use.
Team ID	The unique identifier for the team in System Surveyor.

Get Team System Types {#getteamsystemtypes}

Retrieve all system type elements available for a specific team.

Input	Comments	Default
Connection	The System Surveyor connection to use.
Team ID	The unique identifier for the team in System Surveyor.

Health Check {#healthcheck}

Check the health of the System Surveyor API connection.

Input	Comments	Default
Connection	The System Surveyor connection to use.

List Deleted Sites {#listdeletedsites}

Retrieve a list of deleted sites.

Input	Comments	Default
Connection	The System Surveyor connection to use.
Fetch All	When true, automatically fetches all pages of results using pagination. When false, returns a single page based on the Page Number and Page Size inputs.	false
Page Number	The 1-based page number to retrieve. Used when Fetch All is disabled.
Page Size	The number of records per page. Used when Fetch All is disabled.

List Element Profiles {#listelementprofiles}

Retrieve element profiles available for a specific team.

Input	Comments	Default
Connection	The System Surveyor connection to use.
Team ID	The unique identifier for the team in System Surveyor.
Fetch All	When true, automatically fetches all pages of results using pagination. When false, returns a single page based on the Page Number and Page Size inputs.	false
Page Number	The 1-based page number to retrieve. Used when Fetch All is disabled.
Page Size	The number of records per page. Used when Fetch All is disabled.

List Reports {#listreports}

Retrieve all reports created by the current user.

Input	Comments	Default
Connection	The System Surveyor connection to use.

List Sites {#listsites}

Retrieve a list of sites accessible to the user.

Input	Comments	Default
Connection	The System Surveyor connection to use.
Fetch All	When true, automatically fetches all pages of results using pagination. When false, returns a single page based on the Page Number and Page Size inputs.	false
Page Number	The 1-based page number to retrieve. Used when Fetch All is disabled.
Page Size	The number of records per page. Used when Fetch All is disabled.
Modified After	Filters results to only include records modified after this Unix UTC epoch timestamp. Leave blank to retrieve all records.

List Site Surveys {#listsitesurveys}

Retrieve a list of surveys and folders for a specific site.

Input	Comments	Default
Connection	The System Surveyor connection to use.
Site ID	The unique identifier (UUID) of the site.
Fetch All	When true, automatically fetches all pages of results using pagination. When false, returns a single page based on the Page Number and Page Size inputs.	false
Page Number	The 1-based page number to retrieve. Used when Fetch All is disabled.
Page Size	The number of records per page. Used when Fetch All is disabled.

List Teams {#listteams}

Retrieve all teams the current user is a member of.

Input	Comments	Default
Connection	The System Surveyor connection to use.

Raw Request {#rawrequest}

Send raw HTTP request to System Surveyor.

Input	Comments	Default
Connection	The System Surveyor connection to use.
URL	Input the path only (/v3/sites). For example, to access the sites endpoint (https://openapi.systemsurveyor.com/v3/sites), enter /v3/sites.
Method	The HTTP method to use.
Data	The HTTP body payload to send to the URL.
Form Data	The Form Data to be sent as a multipart form upload.
File Data	File Data to be sent as a multipart form upload.
File Data File Names	File names to apply to the file data inputs. Keys must match the file data keys above.
Query Parameter	A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Header	A list of headers to send with the request.
Response Type	The type of data you expect in the response. You can request json, text, or binary data.	json
Timeout	The maximum time that a client will await a response to its request
Retry Delay (ms)	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.	0
Retry On All Errors	If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.	false
Max Retry Count	The maximum number of retries to attempt. Specify 0 for no retries.	0
Use Exponential Backoff	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.	false

Register Webhook {#registerwebhook}

Register a new webhook endpoint.

Input	Comments	Default
Connection	The System Surveyor connection to use.
Account ID	The internal ID of the System Surveyor account to register the webhook for.
Customer ID	The external customer ID associated with this account.
Webhook Name	A name identifier for the webhook.
Webhook URL	The URL to which the webhook will send POST requests.

Schedule Report {#schedulereport}

Schedule a report to be generated and uploaded to the reports storage.

Input	Comments	Default
Connection	The System Surveyor connection to use.
Report Definition ID	The external ID of the report definition the new report belongs to.
Site ID	The unique identifier (UUID) of the site.
Survey IDs	A list of survey UUID identifiers to include in the request.
Report Name	The display name assigned to the generated report output.
Report Type	The format for the generated report.	xls
Is Site Report	Whether the report is generated at the site level. Set to true for site-level reports, false for survey-level reports.	true

Sync Element Profile {#syncelementprofile}

Create a new or update an existing Element Profile.

Input	Comments	Default
Connection	The System Surveyor connection to use.
Team ID	The unique identifier for the team in System Surveyor.
Element ID	The numeric identifier of the element.
Element Profile Name	The display name assigned to the element profile in System Surveyor.
Content	A JSON array of attribute objects to assign to the element profile. Each object requires an attribute_id and a value. See the Element Profiles API reference for the full schema.
Accessories	A JSON array of accessory objects to assign to the element profile. Each object requires an attribute_id and a value. See the Element Profiles API reference for the full schema.