Introduction
Gophish was built from the ground-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

Installation

To install the gophish library, simply run the command:
pip install gophish

Quickstart

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.
1
from gophish import Gophish
2
3
api_key = 'API_KEY'
4
api = Gophish(api_key)
Copied!
Now you're ready to start using the API!
Last modified 3yr ago
Copy link