Contents

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

This is used to obtain detailed information about specific pot.

Required permission: pots-read

Response:

200 OK:

The backend has successfully returned the detailed information about a specific pot. Returns a PotDetailResponse.

404 Not found:

The pot or instance is unknown to the backend.

Details:

interface PotDetailResponse {

  // Description of the pot. Possibly included
  // in the pot message.
  description: string;

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

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

}