AUaurorasolar
Users

List Users

Returns a list of users.

Users are returned sorted in descending order based on creation date.

get/tenants/{tenant_id}/users

Request

  • Base URL
    https://api-sandbox.aurorasolar.com
  • URL
    https://api-sandbox.aurorasolar.com/tenants/{tenant_id}/users
  • Auth
    HTTP bearer

Path parameters

tenant_idstring uuid required

The ID of the tenant to get users for.

Query parameters

email[]string[]

The email address for the users to retrieve.

external_provider_id[]string[]

The external_provider_id for the users to retrieve.

partner_id[]string[]

The partner_id for the users to retrieve.

Response

Users successfully retrieved.

Example response

{
  "users": [
    {
      "first_name": "Christopher",
      "last_name": "Hopper",
      "email": "support@aurorasolar.com",
      "account_status": "active"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.