HomeGuidesAPI ReferenceChangelog
Log In
API Reference

List TOU Group Intervals

Return intervals for a Time of Use group by lseId and touGroupId.

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

Use this endpoint to return intervals for a Time of Use group.

When to use this endpoint

Use GET /rest/public/timeofuses/{lseId}/{touGroupId}/intervals when you need to:

  • Expand a full TOU group into concrete date-time intervals.
  • Review the schedule for all TOU definitions in a group.
  • Filter group intervals with a fromDateTime and toDateTime range.

Path parameters

ParameterTypeDescription
lseIdLongLSE ID that the TOU group belongs to.
touGroupIdLongTOU group ID whose intervals you want to retrieve.

Optional date filters

ParameterTypeDescription
fromDateTimeDateTimeStarting date and time for returned intervals. Defaults to the current day and time if omitted.
toDateTimeDateTimeEnding date and time for returned intervals. Defaults to one week after fromDateTime if omitted.

Related endpoints

Request Parameters

Along with the standard pagination parameterssearching and sorting parameters, and the required security parameters, the following parameters are available as part of the request:

Query Params
int64
required

Get a TOU group for a specific LSE

int64
required

Get a TOU group by its ID (required when LSE ID is provided)

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