![ssv icon](/docs/img/components/icons/60/c3lzdGVtLXN1cnZleW9y.png) # System Surveyor Connector key: ssv[Source](https://github.com/prismatic-io/components/tree/main/components/system-surveyor)[API Docs](https://docs.openapi.systemsurveyor.com/)[Connector Changelog](#changelog) ## Description[​](#description "Direct link to Description") [System Surveyor](https://www.systemsurveyor.com/) is a platform for designing and managing physical spaces. This component allows creating and managing sites, surveys, element profiles, reports, and webhooks through the System Surveyor REST API. #### API Documentation[​](#api-documentation "Direct link to API Documentation") This component was built using the [System Surveyor REST API](https://docs.openapi.systemsurveyor.com/). ## Connections[​](#connections "Direct link to Connections") ### API Key[​](#ssvapikeyconnection "Direct link to API Key") **key: ssvApiKeyConnection** The System Surveyor API Key connection authenticates via an enterprise access token for API requests. #### Prerequisites[​](#prerequisites "Direct link to Prerequisites") * A System Surveyor enterprise account with API key access enabled * An enterprise access token generated by an account administrator #### Setup Steps[​](#setup-steps "Direct link to Setup Steps") 1. Contact the System Surveyor account administrator to obtain an enterprise access token 2. Determine which API environment to connect to (Production, Staging, or Dev) #### Configure the Connection[​](#configure-the-connection "Direct link to Configure the Connection") Create a connection of type **API Key** and configure the following fields: | Field | Description | | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- | | **Base URL** | The API environment URL. Defaults to the production environment (`https://openapi.systemsurveyor.com`). Change to the staging or dev URL if needed. | | **API Key** | The enterprise access token generated by an account administrator. | | Input | Notes | Example | | -------- | ------------------------------------------------------------------ | ----------------------------------- | | API Key | The enterprise access token generated by an account administrator. | | | Base URL | The base URL for the System Surveyor API environment. | https\://openapi.systemsurveyor.com | ### Basic Authentication[​](#ssvtokenconnection "Direct link to Basic Authentication") **key: ssvTokenConnection** The System Surveyor connection authenticates via email and password to obtain a JWT token for API requests. #### Prerequisites[​](#prerequisites-1 "Direct link to Prerequisites") * A System Surveyor account with API access * Account credentials (email and password) provided by the account administrator #### Setup Steps[​](#setup-steps-1 "Direct link to Setup Steps") 1. Obtain the account email and password from the System Surveyor account administrator 2. Determine which API environment to connect to (Production, Staging, or Dev) #### Configure the Connection[​](#configure-the-connection-1 "Direct link to Configure the Connection") Create a connection of type **Basic Authentication** and configure the following fields: | Field | Description | | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- | | **Base URL** | The API environment URL. Defaults to the production environment (`https://openapi.systemsurveyor.com`). Change to the staging or dev URL if needed. | | **Email** | The email address associated with the System Surveyor account. | | **Password** | The password for the System Surveyor account. | The component authenticates via the [Authentication endpoint](https://docs.openapi.systemsurveyor.com/#tag/Auth/operation/authenticate) to obtain a JWT token for subsequent API requests. | Input | Notes | Example | | -------- | ------------------------------------------------------------ | ----------------------------------- | | 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[​](#triggers "Direct link to Triggers") ### New and Updated Sites[​](#neworupdatedsitestrigger "Direct link to New and Updated Sites") Checks for new and updated sites in System Surveyor on a configured schedule. | **key: newOrUpdatedSitesTrigger** | Input | Notes | Example | | ---------- | -------------------------------------- | ------- | | Connection | The System Surveyor connection to use. | | The **New and Updated Sites** trigger polls the System Surveyor API for newly created or modified sites on a configured schedule. #### How It Works[​](#how-it-works "Direct link to How It Works") 1. On the first execution, the trigger initializes a timestamp cursor and returns no results 2. On subsequent executions, the trigger retrieves all sites modified after the stored cursor timestamp 3. If new or modified sites are found, the trigger returns them and updates the cursor to the current time 4. If no changes are detected, the trigger reports no changes and updates the cursor #### Configuration[​](#configuration "Direct link to Configuration") | Field | Description | | -------------- | ---------------------------------------- | | **Connection** | A configured System Surveyor connection. | The polling schedule is configured at the integration level and determines how frequently the trigger checks for changes. #### Returned Data[​](#returned-data "Direct link to Returned Data") The trigger returns an object containing an array of site records that have been created or modified since the last poll: Example Payload ```json { "data": [ { "id": 123, "name": "Site Name", "modified_at": 1700000000 } ] } ``` *** ## Data Sources[​](#data-sources "Direct link to Data Sources") ### Select Element Profile[​](#selectelementprofile "Direct link to Select Element Profile") Select an element profile from a team's available profiles. | **key: selectElementProfile** | **type: picklist** | Input | Notes | Example | | ---------- | ------------------------------------------------------ | ------- | | Connection | The System Surveyor connection to use. | | | Team ID | The unique identifier for the team in System Surveyor. | 33434 | Example Payload for Select Element Profile[⤓](https://prismatic.io/docs/example-payloads/ssv/data-sources/selectElementProfile.json "Download example payload") Loading… *** ### Select Site[​](#selectsite "Direct link to Select Site") Select a site from available System Surveyor sites. | **key: selectSite** | **type: picklist** | Input | Notes | Example | | ---------- | -------------------------------------- | ------- | | Connection | The System Surveyor connection to use. | | Example Payload for Select Site[⤓](https://prismatic.io/docs/example-payloads/ssv/data-sources/selectSite.json "Download example payload") Loading… *** ### Select Site Survey[​](#selectsitesurvey "Direct link to Select Site Survey") Select a survey from a specific System Surveyor site. | **key: selectSiteSurvey** | **type: picklist** | Input | Notes | Example | | ---------- | ----------------------------------------- | ------------------------------------ | | Site ID | The unique identifier (UUID) of the site. | 6ac251fc-5763-4e21-aa82-0a9efac256e5 | | Connection | The System Surveyor connection to use. | | Example Payload for Select Site Survey[⤓](https://prismatic.io/docs/example-payloads/ssv/data-sources/selectSiteSurvey.json "Download example payload") Loading… *** ### Select Team[​](#selectteam "Direct link to Select Team") Select a team from the current user's teams. | **key: selectTeam** | **type: picklist** | Input | Notes | Example | | ---------- | -------------------------------------- | ------- | | Connection | The System Surveyor connection to use. | | Example Payload for Select Team[⤓](https://prismatic.io/docs/example-payloads/ssv/data-sources/selectTeam.json "Download example payload") Loading… *** ## Actions[​](#actions "Direct link to Actions") ### Get Element Profile Accessories[​](#getelementprofileaccessories "Direct link to Get Element Profile Accessories") Retrieve accessories associated with a specific element profile. | **key: getElementProfileAccessories** | Input | Notes | Example | | ---------- | ------------------------------------------------------ | ------- | | Element ID | The numeric identifier of the element. | 68 | | Connection | The System Surveyor connection to use. | | | Team ID | The unique identifier for the team in System Surveyor. | 33434 | Example Payload for Get Element Profile Accessories[⤓](https://prismatic.io/docs/example-payloads/ssv/actions/getElementProfileAccessories.json "Download example payload") Loading… *** ### Get Site Contacts[​](#getsitecontacts "Direct link to Get Site Contacts") Retrieve contacts associated with a specific site. | **key: getSiteContacts** | Input | Notes | Example | | ---------- | ----------------------------------------- | ------------------------------------ | | Site ID | The unique identifier (UUID) of the site. | 6ac251fc-5763-4e21-aa82-0a9efac256e5 | | Connection | The System Surveyor connection to use. | | Example Payload for Get Site Contacts[⤓](https://prismatic.io/docs/example-payloads/ssv/actions/getSiteContacts.json "Download example payload") Loading… *** ### Get Site Info[​](#getsiteinfo "Direct link to Get Site Info") Retrieve information about a specific site. | **key: getSiteInfo** | Input | Notes | Example | | ---------- | ----------------------------------------- | ------------------------------------ | | Site ID | The unique identifier (UUID) of the site. | 6ac251fc-5763-4e21-aa82-0a9efac256e5 | | Connection | The System Surveyor connection to use. | | Example Payload for Get Site Info[⤓](https://prismatic.io/docs/example-payloads/ssv/actions/getSiteInfo.json "Download example payload") Loading… *** ### Get Sites and Folders[​](#getsitesandfolders "Direct link to Get Sites and Folders") Retrieve a list of sites and folders accessible to the user. | **key: getSitesAndFolders** | Input | Notes | Example | | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | | 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 | | Modified After | Filters results to only include records modified after this Unix UTC epoch timestamp. Leave blank to retrieve all records. | 1672531199 | | Page Number | The 1-based page number to retrieve. Used when Fetch All is disabled. | 1 | | Page Size | The number of records per page. Used when Fetch All is disabled. | 50 | | Connection | The System Surveyor connection to use. | | Example Payload for Get Sites and Folders[⤓](https://prismatic.io/docs/example-payloads/ssv/actions/getSitesAndFolders.json "Download example payload") Loading… *** ### Get Survey[​](#getsurvey "Direct link to Get Survey") Retrieve information about a specific survey. | **key: getSurvey** | Input | Notes | Example | | ---------- | ------------------------------------------- | ------------------------------------ | | Site ID | The unique identifier (UUID) of the site. | 6ac251fc-5763-4e21-aa82-0a9efac256e5 | | Connection | The System Surveyor connection to use. | | | Survey ID | The unique identifier (UUID) of the survey. | 12345678-1234-1234-1234-123456789012 | Example Payload for Get Survey[⤓](https://prismatic.io/docs/example-payloads/ssv/actions/getSurvey.json "Download example payload") Loading… *** ### Get Team Members[​](#getteammembers "Direct link to Get Team Members") Retrieve all members of a specific team. | **key: getTeamMembers** | Input | Notes | Example | | ---------- | ------------------------------------------------------ | ------- | | Connection | The System Surveyor connection to use. | | | Team ID | The unique identifier for the team in System Surveyor. | 33434 | Example Payload for Get Team Members[⤓](https://prismatic.io/docs/example-payloads/ssv/actions/getTeamMembers.json "Download example payload") Loading… *** ### Get Team System Types[​](#getteamsystemtypes "Direct link to Get Team System Types") Retrieve all system type elements available for a specific team. | **key: getTeamSystemTypes** | Input | Notes | Example | | ---------- | ------------------------------------------------------ | ------- | | Connection | The System Surveyor connection to use. | | | Team ID | The unique identifier for the team in System Surveyor. | 33434 | Example Payload for Get Team System Types[⤓](https://prismatic.io/docs/example-payloads/ssv/actions/getTeamSystemTypes.json "Download example payload") Loading… *** ### Health Check[​](#healthcheck "Direct link to Health Check") Check the health of the System Surveyor API connection. | **key: healthCheck** | Input | Notes | Example | | ---------- | -------------------------------------- | ------- | | Connection | The System Surveyor connection to use. | | Example Payload for Health Check[⤓](https://prismatic.io/docs/example-payloads/ssv/actions/healthCheck.json "Download example payload") Loading… *** ### List Deleted Sites[​](#listdeletedsites "Direct link to List Deleted Sites") Retrieve a list of deleted sites. | **key: listDeletedSites** | Input | Notes | Example | | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | | 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. | 1 | | Page Size | The number of records per page. Used when Fetch All is disabled. | 50 | | Connection | The System Surveyor connection to use. | | Example Payload for List Deleted Sites[⤓](https://prismatic.io/docs/example-payloads/ssv/actions/listDeletedSites.json "Download example payload") Loading… *** ### List Element Profiles[​](#listelementprofiles "Direct link to List Element Profiles") Retrieve element profiles available for a specific team. | **key: listElementProfiles** | Input | Notes | Example | | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | | 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. | 1 | | Page Size | The number of records per page. Used when Fetch All is disabled. | 50 | | Connection | The System Surveyor connection to use. | | | Team ID | The unique identifier for the team in System Surveyor. | 33434 | Example Payload for List Element Profiles[⤓](https://prismatic.io/docs/example-payloads/ssv/actions/listElementProfiles.json "Download example payload") Loading… *** ### List Reports[​](#listreports "Direct link to List Reports") Retrieve all reports created by the current user. | **key: listReports** | Input | Notes | Example | | ---------- | -------------------------------------- | ------- | | Connection | The System Surveyor connection to use. | | Example Payload for List Reports[⤓](https://prismatic.io/docs/example-payloads/ssv/actions/listReports.json "Download example payload") Loading… *** ### List Site Surveys[​](#listsitesurveys "Direct link to List Site Surveys") Retrieve a list of surveys and folders for a specific site. | **key: listSiteSurveys** | Input | Notes | Example | | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | | 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. | 1 | | Page Size | The number of records per page. Used when Fetch All is disabled. | 50 | | Site ID | The unique identifier (UUID) of the site. | 6ac251fc-5763-4e21-aa82-0a9efac256e5 | | Connection | The System Surveyor connection to use. | | Example Payload for List Site Surveys[⤓](https://prismatic.io/docs/example-payloads/ssv/actions/listSiteSurveys.json "Download example payload") Loading… *** ### List Sites[​](#listsites "Direct link to List Sites") Retrieve a list of sites accessible to the user. | **key: listSites** | Input | Notes | Example | | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | | 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 | | Modified After | Filters results to only include records modified after this Unix UTC epoch timestamp. Leave blank to retrieve all records. | 1672531199 | | Page Number | The 1-based page number to retrieve. Used when Fetch All is disabled. | 1 | | Page Size | The number of records per page. Used when Fetch All is disabled. | 50 | | Connection | The System Surveyor connection to use. | | Example Payload for List Sites[⤓](https://prismatic.io/docs/example-payloads/ssv/actions/listSites.json "Download example payload") Loading… *** ### List Teams[​](#listteams "Direct link to List Teams") Retrieve all teams the current user is a member of. | **key: listTeams** | Input | Notes | Example | | ---------- | -------------------------------------- | ------- | | Connection | The System Surveyor connection to use. | | Example Payload for List Teams[⤓](https://prismatic.io/docs/example-payloads/ssv/actions/listTeams.json "Download example payload") Loading… *** ### Raw Request[​](#rawrequest "Direct link to Raw Request") Send raw HTTP request to System Surveyor. | **key: rawRequest** | Input | Notes | Example | | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------- | | Connection | The System Surveyor connection to use. | | | Data | The HTTP body payload to send to the URL. | {"exampleKey": "Example Data"} | | File Data | File Data to be sent as a multipart form upload. | \[{key: "example.txt", value: "My File Contents"}] | | File Data File Names | File names to apply to the file data inputs. Keys must match the file data keys above. | | | Form Data | The Form Data to be sent as a multipart form upload. | \[{"key": "Example Key", "value": new Buffer("Hello World")}] | | Header | A list of headers to send with the request. | User-Agent: curl/7.64.1 | | Max Retry Count | The maximum number of retries to attempt. Specify 0 for no retries. | 0 | | Method | The HTTP method to use. | | | 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. | | | Response Type | The type of data you expect in the response. You can request json, text, or binary data. | json | | 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 | | Retry Delay (ms) | The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled. | 0 | | Timeout | The maximum time that a client will await a response to its request | 2000 | | URL | Input the path only (/v3/sites). For example, to access the sites endpoint (https\://openapi.systemsurveyor.com/v3/sites), enter /v3/sites. | /v3/sites | | 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 "Direct link to Register Webhook") Register a new webhook endpoint. | **key: registerWebhook** | Input | Notes | Example | | ------------ | --------------------------------------------------------------------------- | -------------------------------------- | | Account ID | The internal ID of the System Surveyor account to register the webhook for. | 690560 | | Customer ID | The external customer ID associated with this account. | 67890 | | Webhook Name | A name identifier for the webhook. | create\_netsuite\_quote | | Connection | The System Surveyor connection to use. | | | Webhook URL | The URL to which the webhook will send POST requests. | https\://mydomain.com/webhook-endpoint | Example Payload for Register Webhook[⤓](https://prismatic.io/docs/example-payloads/ssv/actions/registerWebhook.json "Download example payload") Loading… *** ### Schedule Report[​](#schedulereport "Direct link to Schedule Report") Schedule a report to be generated and uploaded to the reports storage. | **key: scheduleReport** | Input | Notes | Example | | -------------------- | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | | 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 | | Report Definition ID | The external ID of the report definition the new report belongs to. | d290f1ee-6c54-4b01-90e6-7e7f57220995 | | Report Name | The display name assigned to the generated report output. | Monthly Security Report | | Report Type | The format for the generated report. | xls | | Site ID | The unique identifier (UUID) of the site. | 6ac251fc-5763-4e21-aa82-0a9efac256e5 | | Connection | The System Surveyor connection to use. | | | Survey IDs | A list of survey UUID identifiers to include in the request. | 6ac251fc-5763-4e21-aa82-0a9efac256e5 | Example Payload for Schedule Report[⤓](https://prismatic.io/docs/example-payloads/ssv/actions/scheduleReport.json "Download example payload") Loading… *** ### Sync Element Profile[​](#syncelementprofile "Direct link to Sync Element Profile") Create a new or update an existing Element Profile. | **key: syncElementProfile** | Input | Notes | Example | | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------- | | 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](https://docs.openapi.systemsurveyor.com/#tag/Element-Profiles/operation/create_element_profile) for the full schema. | See Example | | 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](https://docs.openapi.systemsurveyor.com/#tag/Element-Profiles/operation/create_element_profile) for the full schema. | See Example | | Element ID | The numeric identifier of the element. | 68 | | Element Profile Name | The display name assigned to the element profile in System Surveyor. | ACP Server - SW - 11TB | | Connection | The System Surveyor connection to use. | | | Team ID | The unique identifier for the team in System Surveyor. | 33434 | Example Payload for Sync Element Profile[⤓](https://prismatic.io/docs/example-payloads/ssv/actions/syncElementProfile.json "Download example payload") Loading… *** ## Changelog[​](#changelog "Direct link to Changelog") ### 2026-04-30[​](#2026-04-30 "Direct link to 2026-04-30") Updated spectral version ### 2026-03-27[​](#2026-03-27 "Direct link to 2026-03-27") Initial release of System Surveyor component with integration capabilities: * Site management actions: **Get Site Info**, **Get Sites and Folders**, **List Sites**, **List Deleted Sites**, **Get Site Contacts**, **Get Bill of Materials Data**, **List Site Surveys** * **Get Survey** action for retrieving survey details * **Sync Element Profile** action for creating or updating element profiles * **Schedule Report** action for report generation * **Register Webhook** action for webhook endpoint registration * **New and Updated Sites** polling trigger for detecting newly created or modified sites * **Select Site** and **Select Site Survey** data sources for improved input selection * **Raw Request** action for making custom API calls * **Health Check** action for verifying API connectivity