Pools

List Pools

Retrieves a list of Pools filtered by the given parameters.

get/pools

Request

Base URL
https://sandbox.newline53.com/api/v1
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/newline53/apis/newline-platform-api/docs/pools/get.ts
A function with typed inputs. Its response is checked against the schema.

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

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)

Aug 21, 202654f4fe726d8f Revision changes
- info
  added subschema #1 subschema #2 to the // response property allOf list for the response status