Get Utility

GET

https://api.coperniq.io/v1/utilities/:utility_id

Retrieve a specific utility by ID, including catalog metadata and custom field values.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

utility_idstringRequired

Response

Utility details

idintegerOptional

Unique identifier.

namestringOptional

Utility name.

statestring or nullOptional

Two-letter state code (e.g. “CA”).

stateNamestring or nullOptional

Full state name (e.g. “California”).

ownershipTypeenum or nullOptional

holdingCompanystring or nullOptional

addressstring or nullOptional

phonestring or nullOptional

websitestring or nullOptional

hoursOfOperationstring or nullOptional

isActivebooleanOptional

Whether this utility is currently active in the catalog.

createdAtstringOptionalformat: "date-time"

updatedAtstringOptionalformat: "date-time"

custommap from strings to anyOptional

Custom field values keyed by property keyName. This includes only customer-defined custom columns (see GET /properties?record_type=utility). Built-in catalog utility fields (name, state, ownershipType, holdingCompany, etc.) are exposed as top-level fields on the utility object and are read-only.

Errors

401

Unauthorized Error

404

Not Found Error

502

Bad Gateway Error

1	const url = 'https://api.coperniq.io/v1/utilities/utility_id';
2	const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};
3
4	try {
5	const response = await fetch(url, options);
6	const data = await response.json();
7	console.log(data);
8	} catch (error) {
9	console.error(error);
10	}

1	{
2	"id": 1,
3	"name": "string",
4	"state": "string",
5	"stateName": "string",
6	"ownershipType": "INVESTOR",
7	"holdingCompany": "string",
8	"address": "string",
9	"phone": "string",
10	"website": "string",
11	"hoursOfOperation": "string",
12	"isActive": true,
13	"createdAt": "2024-01-15T09:30:00Z",
14	"updatedAt": "2024-01-15T09:30:00Z",
15	"custom": {}
16	}