Gophish was built from the group up to be API-first. This means that we build out the API endpoints for all of our features, and the UI is simply a wrapper around these endpoints.

To interface with Gophish using Python, we've created a gophish client library.

If you want to access the API directly, please refer to our API Documentation

To install the gophish library, simply run the command:

[coming soon]

Getting up and running with the Python library is quick and easy.

To start, simply create a client using the API key found in the Settings page.

from gophish import Gophish

api_key = 'API_KEY'
api = Gophish(api_key)

Now you're ready to start using the API!

You can find the full Python client documentation here.