GET [/instances/$INSTANCES]/private/pots

This is used to return all the pots that are present in our backend.

Required permission: pots-read

Request:

Query Parameters:

• limit – Optional. At most return the given number of results. Negative for descending by serial, positive for ascending by serial. Defaults to -20.

• offset – Optional. Starting serial for pagination.

Response:

200 OK:

The backend has successfully returned all the pots. Returns a PotsSummaryResponse.

404 Not found:

The backend has does not know about the instance.

Details:

interface PotsSummaryResponse {

  // Return pots that are present in our backend.
  pots: PotEntry[];

}

The PotEntry object describes a pot. It has the following structure:

interface PotEntry {

  // Pot identifier
  pot_serial: Integer;

  // Name of the pot. Must be unique per instance.
  pot_name: string;

  // Current total amounts in the pot.
  pot_totals: Amount[];

}