Account Discovery

Discover accessible accounts and user information

Get Current User Profile

get

https://dev.granularregistry.com/apihttp://localhost:8000

/users/me

Get current user information including accessible accounts

Authorizations

ApiKeyAuth

AuthorizationstringRequired

API key authentication using Bearer token format. Example: Authorization: Bearer gcreg_2fCeA78CA62644eB55B0A36249245A27

Responses

200

User profile with accounts

application/json

idintegerRequiredExample: 3

namestringRequiredExample: Demo Admin

emailstring · emailRequiredExample: [email protected]

rolestring · enumRequiredExample: ADMINPossible values:

organisationstring · nullableOptionalExample: Demo Energy Corporation

401

Authentication failed - invalid or missing API key

application/json

get

/users/me

HTTPcURLJavaScriptPython

GET /api/users/me HTTP/1.1
Host: dev.granularregistry.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 3,
  "name": "Demo Admin",
  "email": "[email protected]",
  "role": "ADMIN",
  "accounts": [
    {
      "id": 1,
      "account_name": "Demo Solar Farm Production Account",
      "account_type": "PRODUCTION",
      "account_status": "ACTIVE",
      "organization_id": 2,
      "transfer_disabled": false,
      "description": "Production account for Demo Solar Farm facility",
      "created_by": 3,
      "approved_by": 1,
      "approved_at": "2024-01-01T12:15:00Z",
      "extra_metadata": {}
    }
  ],
  "organisation": "Demo Energy Corporation"
}

Get User's Accessible Accounts

get

https://dev.granularregistry.com/apihttp://localhost:8000

/users/me/accounts

Get list of accounts that the current user can access

Authorizations

ApiKeyAuth

AuthorizationstringRequired

API key authentication using Bearer token format. Example: Authorization: Bearer gcreg_2fCeA78CA62644eB55B0A36249245A27

Responses

200

List of accessible accounts

application/json

idintegerRequiredExample: 1

account_namestringRequiredExample: Demo Solar Farm Production Account

account_typestring · enumRequiredExample: PRODUCTIONPossible values:

account_statusstring · enumRequiredExample: ACTIVEPossible values:

organization_idintegerRequiredExample: 2

transfer_disabledbooleanRequiredExample: false

descriptionstring · nullableOptionalExample: Production account for Demo Solar Farm facility

created_byintegerOptionalExample: 3

approved_byinteger · nullableOptionalExample: 1

approved_atstring · date-time · nullableOptionalExample: 2024-01-01T12:15:00Z

extra_metadataobject · nullableOptional

401

Authentication failed - invalid or missing API key

application/json

get

/users/me/accounts

HTTPcURLJavaScriptPython

GET /api/users/me/accounts HTTP/1.1
Host: dev.granularregistry.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": 1,
    "account_name": "Demo Solar Farm Production Account",
    "account_type": "PRODUCTION",
    "account_status": "ACTIVE",
    "organization_id": 2,
    "description": "Production account for Demo Solar Farm facility"
  },
  {
    "id": 2,
    "account_name": "Demo Wind Farm Production Account",
    "account_type": "PRODUCTION",
    "account_status": "ACTIVE",
    "organization_id": 2,
    "description": "Production account for Demo Wind Farm facility"
  }
]

Get Account Certificate Devices

get

https://dev.granularregistry.com/apihttp://localhost:8000

/accounts/{account_id}/certificates/devices

Get devices that have certificates issued for a specific account

Authorizations

ApiKeyAuth

AuthorizationstringRequired

API key authentication using Bearer token format. Example: Authorization: Bearer gcreg_2fCeA78CA62644eB55B0A36249245A27

Path parameters

account_idintegerRequired

Account ID to query

Example: 1

Responses

200

List of devices with certificates

application/json

idintegerRequiredExample: 1

device_namestringRequiredExample: Solar Farm Main Array

device_technologystringRequiredExample: solar_pv

energy_sourcestringRequiredExample: solar_pv

device_capacityintegerRequired

Device capacity in watts

Example: 100000

locationstringRequiredExample: Austin, TX

production_start_datestring · date-timeOptionalExample: 2023-01-01T00:00:00Z

is_storagebooleanRequiredExample: false

device_statusstring · enumRequiredExample: ACTIVEPossible values:

commissioning_datestring · date-time · nullableOptionalExample: 2023-01-01T00:00:00Z

interconnection_datestring · date-time · nullableOptionalExample: 2023-01-01T00:00:00Z

extra_metadataobject · nullableOptional

created_atstring · date-timeRequiredExample: 2024-01-01T00:00:00Z

401

Authentication failed - invalid or missing API key

application/json

403

Access denied - insufficient permissions or account access

application/json

404

Resource not found

application/json

get

/accounts/{account_id}/certificates/devices

HTTPcURLJavaScriptPython

GET /api/accounts/{account_id}/certificates/devices HTTP/1.1
Host: dev.granularregistry.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": 1,
    "device_name": "Solar Farm Main Array",
    "device_technology": "solar_pv",
    "energy_source": "solar_pv",
    "device_capacity": 100000,
    "location": "Austin, TX",
    "production_start_date": "2023-01-01T00:00:00Z",
    "is_storage": false,
    "device_status": "ACTIVE",
    "commissioning_date": "2023-01-01T00:00:00Z",
    "interconnection_date": "2023-01-01T00:00:00Z",
    "extra_metadata": {},
    "created_at": "2024-01-01T00:00:00Z"
  }
]