StarRez

StarRez is a global leader providing comprehensive software solutions for student housing management and residential community engagement. The StarRez connector enables you to access StarRez REST API endpoints to retrieve student housing data, manage residential records, and integrate housing information with other systems. This connector is particularly useful for applications that need to extract student housing data, integrate housing management with student information systems, build analytics and reporting solutions, or automate residential community workflows.

Power end-to-end data operations for your StarRez API with Nexla. Our bi-directional StarRez connector is purpose-built for StarRez, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to StarRez or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your StarRez workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

• Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
• Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
• API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
• Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a StarRez credential, you'll need to obtain your StarRez portal username and password. StarRez uses Basic Authentication for API access, requiring your portal credentials to authenticate REST API requests.

To obtain StarRez API credentials:

1. Log in to your StarRez portal. You'll need access to your StarRez instance with appropriate permissions for API access.

2. Contact your StarRez administrator or StarRez support to ensure that REST API access is enabled for your account. REST API access may need to be configured at the portal level.

3. Verify that your user account has the necessary permissions to access the REST API endpoints you need. Different endpoints may require different permission levels.

4. Note your Domain URL (instance URL). This is the base URL for your StarRez instance. For example, if your API documentation is available at https://nexla.starrezhousing.com/StarRezREST/services, then your Domain URL is https://nexla.starrezhousing.com (or just nexla.starrezhousing.com).

5. Ensure you have your Username and Password for your StarRez portal account. These are the same credentials you use to log in to the StarRez web portal.

StarRez uses Basic Authentication with username and password for REST API access. Your portal credentials are used to authenticate API requests. Make sure your account has the necessary permissions to access the REST API endpoints you need. If you're unsure about your API access or permissions, contact your StarRez administrator or StarRez support.

For detailed information about StarRez REST API authentication and access, refer to the StarRez Documentation.

Authenticate

Credentials required

Use this authentication mechanism to connect to your StarRez portal with a username and password.

Field	Required	Secret	Description
Domain URL	Yes	No	The URL of your StarRez instance. For example if your API documentation is available at https://nexla.starrezhousing.com/StarRezREST/services then your Domain is https://nexla.starrezhousing.com
Username	Yes	No	The username for connecting to your StarRez account.
Password	Yes	Yes	The password for connecting to your StarRez account.

Create a credential in Nexla

1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – StarRez

2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

3. In the Domain URL field, enter the URL of your StarRez instance. This should be the domain name without the protocol prefix. For example, if your API documentation is available at https://nexla.starrezhousing.com/StarRezREST/services, then your Domain URL is nexla.starrezhousing.com. The default value is nexla.starrezhousing.com.

4. In the Username field, enter your StarRez portal username. This is the username you use to log in to your StarRez portal.

5. In the Password field, enter your StarRez portal password. This is the password you use to log in to your StarRez portal.

   The password is sensitive information and should be kept secure. Your StarRez portal credentials are used for Basic Authentication to access the REST API. Make sure your account has the necessary permissions to access the REST API endpoints you need.

6. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the StarRez connector tile, then select the credential that will be used to connect to the StarRez API, and click Next; or, create a new StarRez credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common StarRez REST API endpoints. 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.

Get Tables

This endpoint fetches all tables that can be used by the web services. Use this endpoint when you need to discover available tables, explore the StarRez database schema, or identify tables for data extraction.

• This endpoint automatically retrieves all available tables from your StarRez instance. No additional configuration is required beyond selecting this endpoint template.

The Get Tables endpoint uses GET requests to retrieve table information from the StarRez REST API. The endpoint returns XML data containing a list of all tables available for use with the web services. For more information about the Get Tables endpoint, refer to the StarRez Documentation.

Get Columns For Table

This endpoint fetches all columns that are present in a specified table. Use this endpoint when you need to discover table structure, explore column definitions, or identify fields for data extraction.

• Enter the table name in the Table Name field. This is the name of the StarRez table for which you want to retrieve column information.

The Get Columns For Table endpoint uses GET requests to retrieve column information from the StarRez REST API. The endpoint returns XML data containing column definitions for the specified table. For more information about the Get Columns For Table endpoint, refer to the StarRez Documentation.

Fetch All Records From Table

This endpoint fetches all records from a table. This endpoint performs a Select * from <Table> StarQL query on the selected table. Use this endpoint when you need to extract all records from a StarRez table, perform full table exports, or retrieve complete datasets.

• Enter the table name in the Table Name field. This is the name of the StarRez table from which you want to fetch all records.

The Fetch All Records From Table endpoint uses POST requests with StarQL queries to retrieve all records from the specified table. The endpoint returns JSON data containing all records from the table. For more information about the Fetch All Records From Table endpoint, refer to the StarRez Documentation.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

StarRez data sources can also be manually configured to ingest data from any valid StarRez REST API endpoint, including sources that use custom StarQL queries, access multiple tables, or require custom authentication headers or request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

StarRez REST API endpoints follow the pattern https://{domain_url}/StarRezREST/services/{endpoint}, where {domain_url} is the Domain URL configured in your credential. Table and column information endpoints (e.g., /StarRezREST/services/databaseinfo/tablelist, /StarRezREST/services/databaseinfo/columnlist/{table}) use GET and return XML — set the path to data using an XPath expression such as */entry/content/Tables or */entry/content/{table}. Record retrieval uses POST with a StarQL query in the request body (e.g., SELECT * FROM {table_name}) sent to /StarRezREST/services/query, returning JSON — set the path to data to $[*] to extract the array of records. The Authorization header for Basic Authentication is included automatically from your credential.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new StarRez 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.