> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tracecat.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Gophish

> Reference for the Tracecat Gophish integration: registered actions, required secrets, expected inputs, and example workflow usage.

## Create campaign

Action ID: `tools.gophish.create_campaign`

Create a campaign in Gophish.

Reference: [https://docs.getgophish.com/api-documentation/campaigns#create-campaign](https://docs.getgophish.com/api-documentation/campaigns#create-campaign)

### Secrets

Required secrets:

* `gophish`: required values `GOPHISH_API_KEY`.

### Input fields

<ParamField path="payload" type="object" required>
  The body of the campaign to create. Look at the Gophish API documentation for the expected body.
</ParamField>

<ParamField path="base_url" type="string | null">
  The base URL of the Gophish instance.

  Default: `null`.
</ParamField>

<ParamField path="verify_ssl" type="boolean">
  If False, disables SSL verification for internal networks.

  Default: `true`.
</ParamField>

## Create group

Action ID: `tools.gophish.create_group`

Create a group in Gophish.

Reference: [https://docs.getgophish.com/api-documentation/users-and-groups#create-group](https://docs.getgophish.com/api-documentation/users-and-groups#create-group)

### Secrets

Required secrets:

* `gophish`: required values `GOPHISH_API_KEY`.

### Input fields

<ParamField path="payload" type="object" required>
  The body of the group to create. Look at the Gophish API documentation for the expected body.
</ParamField>

<ParamField path="base_url" type="string | null">
  The base URL of the Gophish instance.

  Default: `null`.
</ParamField>

<ParamField path="verify_ssl" type="boolean">
  If False, disables SSL verification for internal networks.

  Default: `true`.
</ParamField>

## Create landing page

Action ID: `tools.gophish.create_landing_page`

Create a landing page in Gophish.

Reference: [https://docs.getgophish.com/api-documentation/landing-pages#create-landing-page](https://docs.getgophish.com/api-documentation/landing-pages#create-landing-page)

### Secrets

Required secrets:

* `gophish`: required values `GOPHISH_API_KEY`.

### Input fields

<ParamField path="payload" type="object" required>
  The body of the landing page to create. Look at the Gophish API documentation for the expected body.
</ParamField>

<ParamField path="base_url" type="string | null">
  The base URL of the Gophish instance.

  Default: `null`.
</ParamField>

<ParamField path="verify_ssl" type="boolean">
  If False, disables SSL verification for internal networks.

  Default: `true`.
</ParamField>

## Create sending profile

Action ID: `tools.gophish.create_sending_profile`

Create a sending profile in Gophish.

Reference: [https://docs.getgophish.com/api-documentation/sending-profiles#create-sending-profile](https://docs.getgophish.com/api-documentation/sending-profiles#create-sending-profile)

### Secrets

Required secrets:

* `gophish`: required values `GOPHISH_API_KEY`.

### Input fields

<ParamField path="payload" type="object" required>
  The body of the sending profile to create. Look at the Gophish API documentation for the expected body.
</ParamField>

<ParamField path="base_url" type="string | null">
  The base URL of the Gophish instance.

  Default: `null`.
</ParamField>

<ParamField path="verify_ssl" type="boolean">
  If False, disables SSL verification for internal networks.

  Default: `true`.
</ParamField>

## Create template

Action ID: `tools.gophish.create_template`

Create a template in Gophish.

Reference: [https://docs.getgophish.com/api-documentation/templates#create-template](https://docs.getgophish.com/api-documentation/templates#create-template)

### Secrets

Required secrets:

* `gophish`: required values `GOPHISH_API_KEY`.

### Input fields

<ParamField path="payload" type="object" required>
  The body of the template to create. Look at the Gophish API documentation for the expected body.
</ParamField>

<ParamField path="base_url" type="string | null">
  The base URL of the Gophish instance.

  Default: `null`.
</ParamField>

<ParamField path="verify_ssl" type="boolean">
  If False, disables SSL verification for internal networks.

  Default: `true`.
</ParamField>

## Delete campaign

Action ID: `tools.gophish.delete_campaign`

Delete a campaign in Gophish.

Reference: [https://docs.getgophish.com/api-documentation/campaigns#delete-campaign](https://docs.getgophish.com/api-documentation/campaigns#delete-campaign)

### Secrets

Required secrets:

* `gophish`: required values `GOPHISH_API_KEY`.

### Input fields

<ParamField path="campaign_id" type="integer" required>
  The ID of the campaign to delete.
</ParamField>

<ParamField path="base_url" type="string | null">
  The base URL of the Gophish instance.

  Default: `null`.
</ParamField>

<ParamField path="verify_ssl" type="boolean">
  If False, disables SSL verification for internal networks.

  Default: `true`.
</ParamField>

## Delete group

Action ID: `tools.gophish.delete_group`

Delete a group in Gophish.

Reference: [https://docs.getgophish.com/api-documentation/users-and-groups#delete-group](https://docs.getgophish.com/api-documentation/users-and-groups#delete-group)

### Secrets

Required secrets:

* `gophish`: required values `GOPHISH_API_KEY`.

### Input fields

<ParamField path="group_id" type="integer" required>
  The ID of the group to delete.
</ParamField>

<ParamField path="base_url" type="string | null">
  The base URL of the Gophish instance.

  Default: `null`.
</ParamField>

<ParamField path="verify_ssl" type="boolean">
  If False, disables SSL verification for internal networks.

  Default: `true`.
</ParamField>

## Delete landing page

Action ID: `tools.gophish.delete_landing_page`

Delete a landing page in Gophish.

Reference: [https://docs.getgophish.com/api-documentation/landing-pages#delete-landing-page](https://docs.getgophish.com/api-documentation/landing-pages#delete-landing-page)

### Secrets

Required secrets:

* `gophish`: required values `GOPHISH_API_KEY`.

### Input fields

<ParamField path="landing_page_id" type="integer" required>
  The ID of the landing page to delete.
</ParamField>

<ParamField path="base_url" type="string | null">
  The base URL of the Gophish instance.

  Default: `null`.
</ParamField>

<ParamField path="verify_ssl" type="boolean">
  If False, disables SSL verification for internal networks.

  Default: `true`.
</ParamField>

## Delete sending profile

Action ID: `tools.gophish.delete_sending_profile`

Delete a sending profile in Gophish.

Reference: [https://docs.getgophish.com/api-documentation/sending-profiles#delete-sending-profile](https://docs.getgophish.com/api-documentation/sending-profiles#delete-sending-profile)

### Secrets

Required secrets:

* `gophish`: required values `GOPHISH_API_KEY`.

### Input fields

<ParamField path="sending_profile_id" type="integer" required>
  The ID of the sending profile to delete.
</ParamField>

<ParamField path="base_url" type="string | null">
  The base URL of the Gophish instance.

  Default: `null`.
</ParamField>

<ParamField path="verify_ssl" type="boolean">
  If False, disables SSL verification for internal networks.

  Default: `true`.
</ParamField>

## Delete template

Action ID: `tools.gophish.delete_template`

Delete a template in Gophish.

Reference: [https://docs.getgophish.com/api-documentation/templates#delete-template](https://docs.getgophish.com/api-documentation/templates#delete-template)

### Secrets

Required secrets:

* `gophish`: required values `GOPHISH_API_KEY`.

### Input fields

<ParamField path="template_id" type="integer" required>
  The ID of the template to delete.
</ParamField>

<ParamField path="base_url" type="string | null">
  The base URL of the Gophish instance.

  Default: `null`.
</ParamField>

<ParamField path="verify_ssl" type="boolean">
  If False, disables SSL verification for internal networks.

  Default: `true`.
</ParamField>

## Get campaign

Action ID: `tools.gophish.get_campaign`

Get a campaign from Gophish.

Reference: [https://docs.getgophish.com/api-documentation/campaigns#get-campaign](https://docs.getgophish.com/api-documentation/campaigns#get-campaign)

### Secrets

Required secrets:

* `gophish`: required values `GOPHISH_API_KEY`.

### Input fields

<ParamField path="campaign_id" type="integer" required>
  The ID of the campaign to get.
</ParamField>

<ParamField path="base_url" type="string | null">
  The base URL of the Gophish instance.

  Default: `null`.
</ParamField>

<ParamField path="verify_ssl" type="boolean">
  If False, disables SSL verification for internal networks.

  Default: `true`.
</ParamField>

## Get campaign results

Action ID: `tools.gophish.get_campaign_results`

Get a campaign's results from Gophish.

Reference: [https://docs.getgophish.com/api-documentation/campaigns#get-campaign-results](https://docs.getgophish.com/api-documentation/campaigns#get-campaign-results)

### Secrets

Required secrets:

* `gophish`: required values `GOPHISH_API_KEY`.

### Input fields

<ParamField path="campaign_id" type="integer" required>
  The ID of the campaign to get results for.
</ParamField>

<ParamField path="base_url" type="string | null">
  The base URL of the Gophish instance.

  Default: `null`.
</ParamField>

<ParamField path="verify_ssl" type="boolean">
  If False, disables SSL verification for internal networks.

  Default: `true`.
</ParamField>

## Get campaign summary

Action ID: `tools.gophish.get_campaign_summary`

Get a campaign summary from Gophish.

Reference: [https://docs.getgophish.com/api-documentation/campaigns#get-campaign-summary](https://docs.getgophish.com/api-documentation/campaigns#get-campaign-summary)

### Secrets

Required secrets:

* `gophish`: required values `GOPHISH_API_KEY`.

### Input fields

<ParamField path="campaign_id" type="integer" required>
  The ID of the campaign to get summary for.
</ParamField>

<ParamField path="base_url" type="string | null">
  The base URL of the Gophish instance.

  Default: `null`.
</ParamField>

<ParamField path="verify_ssl" type="boolean">
  If False, disables SSL verification for internal networks.

  Default: `true`.
</ParamField>

## Get group

Action ID: `tools.gophish.get_group`

Get a group from Gophish.

Reference: [https://docs.getgophish.com/api-documentation/users-and-groups#get-group](https://docs.getgophish.com/api-documentation/users-and-groups#get-group)

### Secrets

Required secrets:

* `gophish`: required values `GOPHISH_API_KEY`.

### Input fields

<ParamField path="group_id" type="integer" required>
  The ID of the group to get.
</ParamField>

<ParamField path="base_url" type="string | null">
  The base URL of the Gophish instance.

  Default: `null`.
</ParamField>

<ParamField path="verify_ssl" type="boolean">
  If False, disables SSL verification for internal networks.

  Default: `true`.
</ParamField>

## Get group summary

Action ID: `tools.gophish.get_group_summary`

Get a group summary from Gophish.

Reference: [https://docs.getgophish.com/api-documentation/users-and-groups#get-group-summary](https://docs.getgophish.com/api-documentation/users-and-groups#get-group-summary)

### Secrets

Required secrets:

* `gophish`: required values `GOPHISH_API_KEY`.

### Input fields

<ParamField path="group_id" type="integer" required>
  The ID of the group to get.
</ParamField>

<ParamField path="base_url" type="string | null">
  The base URL of the Gophish instance.

  Default: `null`.
</ParamField>

<ParamField path="verify_ssl" type="boolean">
  If False, disables SSL verification for internal networks.

  Default: `true`.
</ParamField>

## Get landing page

Action ID: `tools.gophish.get_landing_page`

Get a landing page in Gophish.

Reference: [https://docs.getgophish.com/api-documentation/landing-pages#get-landing-page](https://docs.getgophish.com/api-documentation/landing-pages#get-landing-page)

### Secrets

Required secrets:

* `gophish`: required values `GOPHISH_API_KEY`.

### Input fields

<ParamField path="landing_page_id" type="integer" required>
  The ID of the landing page to get.
</ParamField>

<ParamField path="base_url" type="string | null">
  The base URL of the Gophish instance.

  Default: `null`.
</ParamField>

<ParamField path="verify_ssl" type="boolean">
  If False, disables SSL verification for internal networks.

  Default: `true`.
</ParamField>

## Get sending profile

Action ID: `tools.gophish.get_sending_profile`

Get a sending profile in Gophish.

Reference: [https://docs.getgophish.com/api-documentation/sending-profiles#get-sending-profile](https://docs.getgophish.com/api-documentation/sending-profiles#get-sending-profile)

### Secrets

Required secrets:

* `gophish`: required values `GOPHISH_API_KEY`.

### Input fields

<ParamField path="sending_profile_id" type="integer" required>
  The ID of the sending profile to get.
</ParamField>

<ParamField path="base_url" type="string | null">
  The base URL of the Gophish instance.

  Default: `null`.
</ParamField>

<ParamField path="verify_ssl" type="boolean">
  If False, disables SSL verification for internal networks.

  Default: `true`.
</ParamField>

## Get template

Action ID: `tools.gophish.get_template`

Get a template in Gophish.

Reference: [https://docs.getgophish.com/api-documentation/templates#get-template](https://docs.getgophish.com/api-documentation/templates#get-template)

### Secrets

Required secrets:

* `gophish`: required values `GOPHISH_API_KEY`.

### Input fields

<ParamField path="template_id" type="integer" required>
  The ID of the template to get.
</ParamField>

<ParamField path="base_url" type="string | null">
  The base URL of the Gophish instance.

  Default: `null`.
</ParamField>

<ParamField path="verify_ssl" type="boolean">
  If False, disables SSL verification for internal networks.

  Default: `true`.
</ParamField>

## List campaigns

Action ID: `tools.gophish.list_campaigns`

List campaigns from Gophish.

Reference: [https://docs.getgophish.com/api-documentation/campaigns#get-campaigns](https://docs.getgophish.com/api-documentation/campaigns#get-campaigns)

### Secrets

Required secrets:

* `gophish`: required values `GOPHISH_API_KEY`.

### Input fields

<ParamField path="base_url" type="string | null">
  The base URL of the Gophish instance.

  Default: `null`.
</ParamField>

<ParamField path="verify_ssl" type="boolean">
  If False, disables SSL verification for internal networks.

  Default: `true`.
</ParamField>

## List groups

Action ID: `tools.gophish.list_groups`

List groups from Gophish.

Reference: [https://docs.getgophish.com/api-documentation/users-and-groups#get-groups](https://docs.getgophish.com/api-documentation/users-and-groups#get-groups)

### Secrets

Required secrets:

* `gophish`: required values `GOPHISH_API_KEY`.

### Input fields

<ParamField path="base_url" type="string | null">
  The base URL of the Gophish instance.

  Default: `null`.
</ParamField>

<ParamField path="verify_ssl" type="boolean">
  If False, disables SSL verification for internal networks.

  Default: `true`.
</ParamField>

## List groups summary

Action ID: `tools.gophish.list_groups_summary`

List groups summary from Gophish.

Reference: [https://docs.getgophish.com/api-documentation/users-and-groups#get-groups-summary](https://docs.getgophish.com/api-documentation/users-and-groups#get-groups-summary)

### Secrets

Required secrets:

* `gophish`: required values `GOPHISH_API_KEY`.

### Input fields

<ParamField path="base_url" type="string | null">
  The base URL of the Gophish instance.

  Default: `null`.
</ParamField>

<ParamField path="verify_ssl" type="boolean">
  If False, disables SSL verification for internal networks.

  Default: `true`.
</ParamField>

## List landing pages

Action ID: `tools.gophish.list_landing_pages`

List landing pages from Gophish.

Reference: [https://docs.getgophish.com/api-documentation/landing-pages#get-landing-pages](https://docs.getgophish.com/api-documentation/landing-pages#get-landing-pages)

### Secrets

Required secrets:

* `gophish`: required values `GOPHISH_API_KEY`.

### Input fields

<ParamField path="base_url" type="string | null">
  The base URL of the Gophish instance.

  Default: `null`.
</ParamField>

<ParamField path="verify_ssl" type="boolean">
  If False, disables SSL verification for internal networks.

  Default: `true`.
</ParamField>

## List sending profiles

Action ID: `tools.gophish.list_sending_profiles`

List sending profiles from Gophish.

Reference: [https://docs.getgophish.com/api-documentation/sending-profiles#get-sending-profiles](https://docs.getgophish.com/api-documentation/sending-profiles#get-sending-profiles)

### Secrets

Required secrets:

* `gophish`: required values `GOPHISH_API_KEY`.

### Input fields

<ParamField path="base_url" type="string | null">
  The base URL of the Gophish instance.

  Default: `null`.
</ParamField>

<ParamField path="verify_ssl" type="boolean">
  If False, disables SSL verification for internal networks.

  Default: `true`.
</ParamField>

## List templates

Action ID: `tools.gophish.list_templates`

List templates from Gophish.

Reference: [https://docs.getgophish.com/api-documentation/templates#get-templates](https://docs.getgophish.com/api-documentation/templates#get-templates)

### Secrets

Required secrets:

* `gophish`: required values `GOPHISH_API_KEY`.

### Input fields

<ParamField path="base_url" type="string | null">
  The base URL of the Gophish instance.

  Default: `null`.
</ParamField>

<ParamField path="verify_ssl" type="boolean">
  If False, disables SSL verification for internal networks.

  Default: `true`.
</ParamField>

## Modify group

Action ID: `tools.gophish.modify_group`

Modify a group in Gophish.

Reference: [https://docs.getgophish.com/api-documentation/users-and-groups#modify-group](https://docs.getgophish.com/api-documentation/users-and-groups#modify-group)

### Secrets

Required secrets:

* `gophish`: required values `GOPHISH_API_KEY`.

### Input fields

<ParamField path="group_id" type="integer" required>
  The ID of the group to modify.
</ParamField>

<ParamField path="payload" type="object" required>
  The body of the group to modify. Look at the Gophish API documentation for the expected body.
</ParamField>

<ParamField path="base_url" type="string | null">
  The base URL of the Gophish instance.

  Default: `null`.
</ParamField>

<ParamField path="verify_ssl" type="boolean">
  If False, disables SSL verification for internal networks.

  Default: `true`.
</ParamField>

## Modify landing page

Action ID: `tools.gophish.modify_landing_page`

Modify a landing page in Gophish.

Reference: [https://docs.getgophish.com/api-documentation/landing-pages#modify-landing-page](https://docs.getgophish.com/api-documentation/landing-pages#modify-landing-page)

### Secrets

Required secrets:

* `gophish`: required values `GOPHISH_API_KEY`.

### Input fields

<ParamField path="landing_page_id" type="integer" required>
  The ID of the landing page to modify.
</ParamField>

<ParamField path="payload" type="object" required>
  The body of the landing page to modify. Look at the Gophish API documentation for the expected body.
</ParamField>

<ParamField path="base_url" type="string | null">
  The base URL of the Gophish instance.

  Default: `null`.
</ParamField>

<ParamField path="verify_ssl" type="boolean">
  If False, disables SSL verification for internal networks.

  Default: `true`.
</ParamField>

## Modify sending profile

Action ID: `tools.gophish.modify_sending_profile`

Modify a sending profile in Gophish.

Reference: [https://docs.getgophish.com/api-documentation/sending-profiles#modify-sending-profile](https://docs.getgophish.com/api-documentation/sending-profiles#modify-sending-profile)

### Secrets

Required secrets:

* `gophish`: required values `GOPHISH_API_KEY`.

### Input fields

<ParamField path="payload" type="object" required>
  The body of the sending profile to modify. Look at the Gophish API documentation for the expected body.
</ParamField>

<ParamField path="sending_profile_id" type="integer" required>
  The ID of the sending profile to modify.
</ParamField>

<ParamField path="base_url" type="string | null">
  The base URL of the Gophish instance.

  Default: `null`.
</ParamField>

<ParamField path="verify_ssl" type="boolean">
  If False, disables SSL verification for internal networks.

  Default: `true`.
</ParamField>

## Modify template

Action ID: `tools.gophish.modify_template`

Modify a template in Gophish.

Reference: [https://docs.getgophish.com/api-documentation/templates#modify-template](https://docs.getgophish.com/api-documentation/templates#modify-template)

### Secrets

Required secrets:

* `gophish`: required values `GOPHISH_API_KEY`.

### Input fields

<ParamField path="payload" type="object" required>
  The body of the template to modify. Look at the Gophish API documentation for the expected body.
</ParamField>

<ParamField path="template_id" type="integer" required>
  The ID of the template to modify.
</ParamField>

<ParamField path="base_url" type="string | null">
  The base URL of the Gophish instance.

  Default: `null`.
</ParamField>

<ParamField path="verify_ssl" type="boolean">
  If False, disables SSL verification for internal networks.

  Default: `true`.
</ParamField>