HomeGuidesAPI ReferenceChangelog
Log In
API Reference

Get TOU

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Retrieve one time-of-use definition by touId.

Use this endpoint when you already know the Arcadia TOU ID and need the individual time-of-use definition, including its display name, TOU group, season, calendar, and periods.

Resource URI

GET /rest/public/timeofuses/{touId}

Path parameters

ParameterTypeDescription
touIdLongUnique Arcadia ID for the time-of-use definition. Required.

For the full TimeOfUse and period data models, see Time of Uses.

Example

GET /rest/public/timeofuses/50959

A successful response returns a standard response payload with type set to TimeOfUse and one TOU definition in the results array.

Path Params
int64
required

Unique Arcadia ID (primary key) for each time of use. This is unique across all LSEs.

Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json