Skip to main content

Get list of available Cages

Request

Only Cages available for EIA should be returned

Security
BearerAuth
Query
location.ibxstringrequired

IBX code for given location

Example:location.ibx=CH2
account.accountNumberstringrequired

Account number

Example:account.accountNumber=123111232
offsetinteger, >= 0

Pagination offset

Default:0
Example:offset=0
limitinteger, [ 0 .. 250 ]

Max number of returned results

Default:50
Example:limit=50
Payload
// No request payload

Responses

List of Cages

Bodyapplication/json
paginationobject(Pagination)required
dataArray of objects(Cage)required
Response
{ "pagination": { "offset": 0, "limit": 20, "total": 1 }, "data": [ { … }, { … } ] }
Was this page helpful?