latestOpenAPI 3.0.22026-08-21530310.0 KB

54f4fe726d8f

Pools

List Pools

Retrieves a list of Pools filtered by the given parameters.

get/pools

Query parameters

customer_uidstring
Example:uKxmLxUEiSj5h4M3

Filter by Customer. Multiple values are allowed, e.g. customer_uid[]=uKxmLxUEiSj5h4M3&customer_uid[]=y9reyPMNEWuuYSC1.

limitinteger

Maximum number of items to retrieve. This filter is automatically applied with the default value if not given.

offsetinteger

Index of the items to start retrieving from

Response

A list of Pools is returned

total_countinteger

Total count of items available to retrieve

countinteger

Number of items retrieved

limitinteger

Maximum number of items to retrieve

offsetinteger

Index of the first item to retrieve

dataSchema[] — unresolved $ref