Skip to main content
GET
List Allocation Series

Authorizations

Authorization
string
header
required

Query Parameters

accounting_point_id
string<uuid>[] | null

Accounting points to read. Omit to read every point.

Maximum array length: 500
market_identifier
string[] | null

Market identifiers of the accounting points to read, for example EAN codes. A series matches when its identifier has one of the values, whatever its kind. Omit to read every identifier.

Maximum array length: 500
flow_direction
enum<string>[] | null

Flow directions to read. Omit to read both.

Available options:
consumption,
production
offset
integer
default:0

The position of the first series of the page in the list. The first series in the list has the position 0.

Required range: 0 <= x <= 9223372036854776000
limit
integer
default:100

The maximum number of series on the page.

Required range: 1 <= x <= 1000

Response

Successful Response

items
AllocationSeriesItem · object[]
required
limit
integer
required
offset
integer
required
total
integer
required

The number of series that agree with the filters, on all pages.