Skip to main content
GET
List networks

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

Idempotency-Key
string<uuid>
required

Client-generated unique key per operation intent (UUID). Same key + identical body replays the original response; same key + different body returns 409.

Query Parameters

after
string

Cursor to start fetching records after — the pagination.end_cursor of a previous response. Omit it to fetch the first page, and stop paging once pagination.has_next is false. Sending it empty is a 400: an empty cursor is a broken cursor, not a request for the first page.

Minimum string length: 1
cursor
string

Deprecated: use after.

Minimum string length: 1
limit
number
default:50

Results per page (1–200)

network_type
enum<string>
required

Which kind of network to list — BASE for base networks (the full collections of operators your roaming identities can reach), or SUB for sub-networks (the named slices you've created from them).

Available options:
BASE,
SUB
protocol
enum<string>

Only return networks using a particular roaming standard version.

Available options:
OCPI_211,
OCPI_221,
OCPI_230,
OICP_23
roaming_hub
string

Only return networks reached through a particular roaming hub (such as Hubject).

parent_network_id
string

Only return sub-networks created from this parent base network.

published
boolean

Filter BASE networks by their published flag. Ignored when network_type=SUB.

Response

200 - application/json

Paginated list of networks visible to the calling tenant.

pagination
object
required

Pagination state for this page.

next_cursor
string | null
required
deprecated

Deprecated: use pagination.end_cursor.

Example:

null

has_next
boolean
required
deprecated

Deprecated: use pagination.has_next.

Example:

false

data
object[]
required