GET /api/v3/primaryuse

Retrieves all primary uses, optionally filtered by type

GetPrimaryUsesV3
Use this endpoint to get a list of primary uses. Supports filtering by primary use type (e.g., “meter” or “place”) via the filter parameter.

Request Headers

Header Value Required Description
ECI-ApiKey string Yes Your API key. See Authentication.
Content-Type application/json Yes All requests must specify JSON content type.

Query Parameters

Name Description Type Required
filter Optional primary use filter. Supports filtering by primaryUseType with values ‘meter’ or ‘place’. string (string) Optional

Filters

Filter Description Type Operators
primaryusetype Primary Use Type Code String equals

Responses

200 OK The request succeeded and the response body contains the requested data.

Response Body Parameters

Array of:

PrimaryUseResponse
Property Description Type
primaryUseCode string
primaryUseId integer (int32)
primaryUseInfo string
primaryUseType string
Example Response application/json 
[
  {    "primaryUseCode": "string",    "primaryUseId": 1,    "primaryUseInfo": "string",    "primaryUseType": "string"
  }
]