GET public/v2/pools?includeHidden={includeHidden}

Return list of pools available to user

Request Information

URI Parameters

NameDescriptionTypeAdditional information
includeHidden

boolean

Default value is True

Body Parameters

None.

Response Information

Resource Description

Collection of BitPool.Base.Entities.BitPoolEntity
NameDescriptionTypeAdditional information
PoolKey

globally unique identifier

None.

Name

string

None.

RegistrationDate

date

None.

Virtual

boolean

None.

Public

boolean

None.

Owner

boolean

None.

AccessMode

BitPool.Base.Enums.BitPoolUserRolesTypes

None.

UtcOffset

decimal number

None.

TimeZone

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "PoolKey": "feb868e0-2054-4709-805f-541878bc5c99",
    "Name": "sample string 2",
    "RegistrationDate": "2019-05-19T19:45:36.638+00:00",
    "Virtual": true,
    "Public": true,
    "Owner": true,
    "AccessMode": 0,
    "UtcOffset": 7.1,
    "TimeZone": "sample string 8"
  },
  {
    "PoolKey": "feb868e0-2054-4709-805f-541878bc5c99",
    "Name": "sample string 2",
    "RegistrationDate": "2019-05-19T19:45:36.638+00:00",
    "Virtual": true,
    "Public": true,
    "Owner": true,
    "AccessMode": 0,
    "UtcOffset": 7.1,
    "TimeZone": "sample string 8"
  }
]

application/xml, text/xml

Sample:
<ArrayOfBitPoolEntity>
  <BitPoolEntity>
    <PoolKey>feb868e0-2054-4709-805f-541878bc5c99</PoolKey>
    <Name>sample string 2</Name>
    <RegistrationDate>2019-05-19T19:45:36.6386152+00:00</RegistrationDate>
    <Virtual>true</Virtual>
    <Public>true</Public>
    <Owner>true</Owner>
    <AccessMode>Administrator</AccessMode>
    <UtcOffset>7.1</UtcOffset>
    <TimeZone>sample string 8</TimeZone>
  </BitPoolEntity>
  <BitPoolEntity>
    <PoolKey>feb868e0-2054-4709-805f-541878bc5c99</PoolKey>
    <Name>sample string 2</Name>
    <RegistrationDate>2019-05-19T19:45:36.6386152+00:00</RegistrationDate>
    <Virtual>true</Virtual>
    <Public>true</Public>
    <Owner>true</Owner>
    <AccessMode>Administrator</AccessMode>
    <UtcOffset>7.1</UtcOffset>
    <TimeZone>sample string 8</TimeZone>
  </BitPoolEntity>
</ArrayOfBitPoolEntity>