Aurora Solar

Aurora Solar Agreements API

Customer agreements and signed downloads.

Documentation GitHub OpenAPI

Operations 3

GET /tenants/{tenant_id}/agreements List agreements #

GET /tenants/{tenant_id}/agreements/{agreement_id} Retrieve an agreement #

GET /tenants/{tenant_id}/agreements/{agreement_id}/link Retrieve agreement link #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/aurora-solar-agreements-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Aurora Solar Agreements API
  description: The Aurora API lets you build apps and integrations on the Aurora Solar platform for solar sales and design.
  version: v2024.05
  contact:
    name: Aurora Solar Developer Platform
    url: https://docs.aurorasolar.com
  license:
    name: Proprietary
    url: https://aurorasolar.com/terms-of-service/
servers:
- url: https://api.aurorasolar.com
  description: Production
- url: https://api-sandbox.aurorasolar.com
  description: Sandbox
security:
- bearerAuth: []
tags:
- name: Agreements
  description: Customer agreements and signed downloads.
paths:
  /tenants/{tenant_id}/agreements:
    parameters:
    - $ref: '#/components/parameters/TenantId'
    get:
      operationId: listAgreements
      tags:
      - Agreements
      summary: List agreements
      description: Lists customer agreements for the tenant.
      x-modeled: true
      responses:
        '200':
          description: A list of agreements.
          content:
            application/json:
              schema:
                type: object
                properties:
                  agreements:
                    type: array
                    items:
                      $ref: '#/components/schemas/Agreement'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /tenants/{tenant_id}/agreements/{agreement_id}:
    parameters:
    - $ref: '#/components/parameters/TenantId'
    - name: agreement_id
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: retrieveAgreement
      tags:
      - Agreements
      summary: Retrieve an agreement
      description: Retrieves a customer agreement by ID.
      x-modeled: true
      responses:
        '200':
          description: The requested agreement.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Agreement'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /tenants/{tenant_id}/agreements/{agreement_id}/link:
    parameters:
    - $ref: '#/components/parameters/TenantId'
    - name: agreement_id
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: retrieveAgreementLink
      tags:
      - Agreements
      summary: Retrieve agreement link
      description: Retrieves a hosted link where the customer can view/sign the agreement.
      x-modeled: true
      responses:
        '200':
          description: The agreement link.
          content:
            application/json:
              schema:
                type: object
                properties:
                  url:
                    type: string
                    format: uri
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    Agreement:
      type: object
      properties:
        id:
          type: string
          format: uuid
        project_id:
          type: string
        status:
          type: string
          enum:
          - draft
          - sent
          - signed
          - declined
        signed_at:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
              title:
                type: string
              detail:
                type: string
  responses:
    NotFound:
      description: The requested resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing or invalid bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    TenantId:
      name: tenant_id
      in: path
      required: true
      description: The tenant (organization) ID that owns the resource.
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'API-key bearer token. Standard keys are prefixed `sk_`, Restricted keys `rk_`; `sand_`/`prod_` denote sandbox vs production. Passed as `Authorization: Bearer <token>`.'