API Reference

Partners

📘

Partner Management is available on the Grow and Scale tiers of Aurora’s Business plans or as an add-on to Custom plans.

Partners in Aurora enable solar businesses to create and manage external business user groups and projects. When users are assigned to a Partner, they can only access the projects assigned to that Partner; they are unable to access projects assigned to other Partners. Admin users are able to access all projects across all Partners. Once assigned to a Partner, a project cannot be moved to another Partner.

Today, Aurora offers the following partners-related API endpoints:

You can assign users to partners by supplying partner_ids or partner_id (deprecated) in Create User and Invite User API calls. List Users endpoint also comes with partner_id filter so you can list all users assigned to one or more partners in a single API call. Lastly, you can lookup if and which partner(s) a user has been assigned to using Retrieve User endpoint.

You can assign projects to a partner by supplying partner_id in Create Project API calls. If no partner_id is provided on project creation, partner_id will default to the partner of the owner_id if the project owner belongs to a single partner. In addition, you can lookup if and which partner a project has been assigned to using Retrieve Project endpoint.