Skip to main content

OfficeSpace Software Data Source

The OfficeSpace Software connector enables you to ingest workspace data — including employees, seats, floors, sites, and directories — directly into Nexla data flows. Follow the instructions below to create a new data flow that ingests data from an OfficeSpace Software source in Nexla.
officespace_api.png

OfficeSpace Software

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the OfficeSpace Software connector tile from the list of available connectors. Then, select the credential that will be used to connect to the OfficeSpace Software instance, and click Next; or, create a new OfficeSpace Software credential for use in this flow.

  3. In Nexla, OfficeSpace Software data sources can be created using pre-built endpoint templates, which expedite source setup for common OfficeSpace Software endpoints. Each template is designed specifically for the corresponding OfficeSpace Software endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    OfficeSpace Software sources can also be configured manually, allowing you to ingest data from OfficeSpace Software endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common OfficeSpace Software endpoints. Each template is designed specifically for the corresponding OfficeSpace Software endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

Get Employees

Retrieve all active employees in your OfficeSpace directory, including profile fields, seating status, seat URLs, and directory metadata. Use this endpoint to export your organization's complete employee roster for HR analytics, workforce planning, or synchronization with external systems.

  • This endpoint requires no additional parameters. Selecting it will automatically retrieve all active employee records from your OfficeSpace instance.
  • Each returned record includes employee profile fields (such as name, email, and department), their current seating assignment, seat URL, and any directory group memberships.

The OfficeSpace API returns employee data under the $.response[*] path. Nexla automatically applies this path when using the pre-built template. For additional details about the OfficeSpace employee data model, refer to the OfficeSpace API documentation.

Get Seats

Retrieve all seats in your OfficeSpace environment, including occupancy status, floor reference, seat label, and the current occupant URL. Use this endpoint for space utilization analysis, desk allocation reporting, or feeding occupancy data into downstream analytics tools.

  • This endpoint requires no additional parameters. Selecting it will automatically retrieve all seat records across all floors and sites in your OfficeSpace instance.
  • Each returned record includes the seat's label, its associated floor, its occupancy status (occupied or vacant), and a URL reference to the current occupant's employee record if occupied.

Seat data is particularly useful when combined with floor and site data from the Get Floors and Get Sites endpoints to build a complete picture of your organization's space utilization.

Get Floors

Retrieve all floors in your OfficeSpace environment, including floor labels, site associations, and directory group references. Use this endpoint to map your organization's physical space hierarchy or to enrich seat and employee data with floor-level context.

  • This endpoint requires no additional parameters. Selecting it will automatically retrieve all floor records across all sites in your OfficeSpace instance.
  • Each returned record includes the floor's label, its parent site association, and any linked directory groups that control visibility or access for that floor.

Floor IDs returned by this endpoint can be used to cross-reference seat records from the Get Seats endpoint, enabling complete floor-to-seat mapping in your Nexla data flows.

Get Sites

Retrieve all office sites in your OfficeSpace portfolio, including site name and site ID. Use this endpoint for multi-location portfolio analysis, real estate planning, or to provide site context when joining with floor and seat data.

  • This endpoint requires no additional parameters. Selecting it will automatically retrieve all site records for your OfficeSpace instance.
  • Each returned record includes the site's name and its unique OfficeSpace site ID, which can be used to associate floors and seats with specific physical office locations.

Site IDs are useful as join keys when building multi-source Nexla flows that combine site, floor, seat, and employee data for comprehensive occupancy reporting.

Get Directories

Retrieve all floor directories in your OfficeSpace environment, including system visibility groups such as Make Public and Make Private. Use this endpoint to understand how seat and floor data is organized and filtered across your organization.

  • This endpoint requires no additional parameters. Selecting it will automatically retrieve all directory records for your OfficeSpace instance.
  • Each returned record includes the directory name and its visibility configuration, which controls whether associated floors and seats appear in public or restricted views within OfficeSpace.

Directory data is primarily useful for administrative reporting and for understanding how OfficeSpace visibility rules affect seat and floor data returned by the Get Seats and Get Floors endpoints.

Get Employee by ID

Retrieve a single employee record by their OfficeSpace internal employee ID, including full seating details, profile fields, and directory membership information. Use this endpoint when you need to enrich or validate a specific employee's data in a targeted data flow.

  • Enter the OfficeSpace internal employee ID in the Employee ID field. This is a required parameter. The employee ID is the unique identifier assigned to each employee by OfficeSpace — it is distinct from your HR system's employee ID.

    • To find an employee's OfficeSpace ID, first use the Get Employees endpoint to retrieve a list of all active employees. Each employee record in that response includes the OfficeSpace internal ID that can be used here.
  • Once the Employee ID is entered, Nexla will retrieve the full record for that employee, including their profile fields, current seat assignment, seat URL, and directory group memberships.

The Get Employee by ID endpoint is best suited for targeted lookups or for flows where a specific employee ID is already known. To retrieve data for all employees, use the Get Employees endpoint instead.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

OfficeSpace Software data sources can be manually configured to ingest data from any valid OfficeSpace API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex OfficeSpace Software sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom request parameters.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the OfficeSpace Software API from the Method pulldown menu. The most common methods are:

    • GET: For retrieving data from the API
    • POST: For sending data to the API or triggering actions
    • PUT: For updating existing data
    • PATCH: For partial updates to existing data
    • DELETE: For removing data

API Endpoint URL​

  1. Enter the URL of the OfficeSpace Software API endpoint from which this source will fetch data in the Set API URL field. OfficeSpace API endpoints follow the pattern https://{hostname}.officespacesoftware.com/api/1/{resource}, where {hostname} is your instance subdomain and {resource} is the name of the resource (e.g., employees, seats, floors, sites, directories).

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. For a complete list of available OfficeSpace API endpoints, refer to the OfficeSpace API documentation.

Date/Time Macros (API URL)​

Optional

Optionally, the API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods or data requirements.

Macros are particularly useful for OfficeSpace APIs that support date-range filtering or other dynamic query parameters that change between data ingestion runs.

  1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

    • {now} – The current datetime
    • {now-1} – The datetime one time unit before the current datetime
    • {now+1} – The datetime one time unit after the current datetime
    • custom – Datetime macros can reference any number of time units before or after the current datetime—for example, enter (now-4) to indicate the datetime four time units before the current datetime

  2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. This format will be applied to the base datetime value of the macro—i.e., the value of {now} in {now-1}.

  3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro {now-1}, when Day is selected, {now-1} will be converted to the datetime one day before the current datetime.

Lookup-Based Macros (API URL)​

Optional

Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that can adapt based on existing data.

Lookup-based macros are useful when building OfficeSpace flows that reference specific employee IDs, site IDs, or other identifiers retrieved from a previous step in the pipeline.

  1. To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.

  2. Type { at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.

Path to Data​

Optional

If only a subset of the data returned by the OfficeSpace API endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response.

For example, OfficeSpace API responses wrap records in a top-level response object. By entering the path to the relevant data (e.g., $.response[*]), you can configure Nexla to treat each element of the returned array as an individual record.

Path to Data is essential for OfficeSpace API responses, which use a response wrapper. Without specifying the correct path, Nexla may treat the entire response object as a single record rather than expanding individual employee, seat, or floor records.

  • To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

    • For responses in JSON format enter the JSON path that points to the object or array that should be treated as relevant data. For most OfficeSpace endpoints, this will be $.response[*] (for collection endpoints) or $.response (for single-record endpoints like Get Employee by ID).

    • For responses in XML format, enter the XPath that points to the object/array containing relevant data.

    Path to Data Example:

    For the OfficeSpace GET /api/1/employees endpoint, the response wraps all employee records in a top-level response array. Enter $.response[*] as the path to data so that Nexla treats each employee object as a separate record.

Autogenerate Path Suggestions​

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

  • To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

  • Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

    PathSuggestions.png

Metadata​

If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record. This is useful when you want to preserve important contextual information that applies to all records but is not part of the main data array.

Metadata paths are particularly useful for preserving OfficeSpace API response context such as request timestamps or summary statistics that apply to all records in the response.

  • To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.

    • For responses in JSON format, enter the JSON path to the object or array that contains the metadata, and for responses in XML format, enter the XPath.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). Additional headers are often required for API versioning, content type specifications, or custom request requirements.

    You do not need to include the Authorization header or any other headers already present in the OfficeSpace credential. Nexla automatically includes the Authorization: Token token=<your_api_key> header on every API call based on your configured credential.

Endpoint Testing​

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Save & Activate the Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new OfficeSpace Software data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.