Skip to content

2. API Response Structure

openphish edited this page Jun 23, 2021 · 1 revision

The API returns successful and failed operations in the following structure. In the command line option, the output is encoded into JSON. When using the API programmatically, the output is a Python3 dictionary object.

{
  "success": <True when successful, False otherwise>, 
  "message": <Message describing the operation status>,
  "data":    <Object containing the results>
}

Clone this wiki locally