find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/securonix-spearphish-events-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: ThreatQ Spearphish Events API
  description: '© 2025


    The API doc you are viewing is a BETA version that provides an early look at ThreatQ’s new API documentation format.'
  license:
    name: null
    url: null
  version: 1.0.0
  x-logo:
    url: null
    backgroundColor: null
    altText: ThreatQuotient
servers:
- description: SwaggerHub API Auto Mocking
  url: https://virtserver.swaggerhub.com/securonix-b7a/ThreatQ/1.0.0
- url: https://threatq.com/api
  description: ThreatQ Server
security:
- BearerAuth: []
tags:
- name: Spearphish Events
paths:
  /events/{event_id}/spearphish:
    post:
      tags:
      - Spearphish Events
      summary: Create a Spearphish Event
      parameters:
      - $ref: '#/components/parameters/EventId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SpearphishFillable'
      responses:
        '201':
          description: New Spearphish Event Created
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/Spearphish'
                type: object
        '400':
          $ref: '#/components/responses/FailedValidation'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-visibility: public
      operationId: postEventsByEventIdSpearphish
      x-operation-id-source: derived
  /events/{event_id}/spearphish/{spearphish_id}{?with}:
    get:
      tags:
      - Spearphish Events
      summary: Get a Single Spearphish Event
      parameters:
      - $ref: '#/components/parameters/EventId'
      - $ref: '#/components/parameters/SpearphishId'
      - $ref: '#/components/parameters/SpearphishWith'
      responses:
        '200':
          description: Request Successful
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/SpearphishWithEvent'
                type: object
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-visibility: public
      operationId: getEventsByEventIdSpearphishBySpearphishId}{?with
      x-operation-id-source: derived
    put:
      tags:
      - Spearphish Events
      summary: Update a Spearphish Event
      parameters:
      - $ref: '#/components/parameters/EventId'
      - $ref: '#/components/parameters/SpearphishId'
      - $ref: '#/components/parameters/SpearphishWith'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SpearphishFillable'
      responses:
        '201':
          description: Spearphish Event Updated
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/SpearphishWithEvent'
                type: object
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-visibility: public
      operationId: putEventsByEventIdSpearphishBySpearphishId}{?with
      x-operation-id-source: derived
  /events/{event_id}/spearphish{?limit,offset,sort,with}:
    get:
      tags:
      - Spearphish Events
      summary: List Spearphish Events
      parameters:
      - $ref: '#/components/parameters/EventId'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/SpearphishWith'
      responses:
        '200':
          description: Request Successful
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    data:
                      type: array
                      items:
                        $ref: '#/components/schemas/SpearphishWithEvent'
                  type: object
                - $ref: '#/components/schemas/TotalResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-visibility: public
      operationId: getEventsByEventIdSpearphish{?limit,offset,sort,with}
      x-operation-id-source: derived
components:
  responses:
    Unauthorized:
      description: Unauthorized
    FailedValidation:
      description: Validation Failed
    NotFound:
      description: Object Not Found
  schemas:
    TotalResponse:
      properties:
        total:
          description: Total Number of Objects Processed
          type: integer
          example: 1
      type: object
    ThreatQTimestamps:
      properties:
        created_at:
          description: Creation Date
          type: string
          example: '2021-07-29 13:58:03'
        updated_at:
          description: Update Date
          type: string
          example: '2022-04-12 08:32:16'
      type: object
    EventFillable:
      properties:
        type_id:
          description: Event Type ID
          type: integer
          example: 1
        title:
          description: Event Title
          type: string
          example: 'Fwd:  for you ????'
        happened_at:
          description: Date Event Occurred
          type: string
          example: '2019-12-18 16:57:00'
        hash:
          description: Hash of the Event happened_at and title
          type: string
          example: 02f0897a6516236de8bc4c958d2803ca
        description:
          description: Event Description
          type: string
          example: This Event was observed when...
      type: object
    TouchedAtTimestamp:
      properties:
        touched_at:
          description: Update Date for Object Context (Attributes, Comments, Sources, Relationships)
          type: string
          example: '2021-11-13 15:28:17'
      type: object
    SpearphishWithEvent:
      allOf:
      - properties:
          event:
            $ref: '#/components/schemas/Event'
        type: object
      - $ref: '#/components/schemas/Spearphish'
    Spearphish:
      allOf:
      - properties:
          id:
            description: Spearphish ID
            type: integer
            example: 1
          event_id:
            description: ID for related Event
            type: integer
            example: 54
        type: object
      - properties:
          hash:
            description: Hash of the Spearphish value
            type: string
            example: dd829f2f1ce7a37b01c0cdb6adae8496
          last_parsed_at:
            description: Date the Spearphish Email was parsed (if the Spearphish was imported)
            type: string
            example: '2020-01-24 20:21:51'
          created_at:
            description: Spearphish Creation Date
            type: string
            example: '2020-05-01 02:35:16'
          updated_at:
            description: Spearphish Update Date
            type: string
            example: '2020-05-03 04:27:51'
        type: object
      - $ref: '#/components/schemas/SpearphishFillable'
    Event:
      allOf:
      - properties:
          id:
            description: Event ID
            type: integer
            example: 54
        type: object
      - $ref: '#/components/schemas/EventFillable'
      - $ref: '#/components/schemas/ThreatQTimestamps'
      - $ref: '#/components/schemas/TouchedAtTimestamp'
    SpearphishFillable:
      properties:
        subject:
          description: Spearphish Email Subject
          type: string
          example: 'Fwd:  for you ????'
        sender:
          description: Spearphish Email Sender
          type: string
          example: bad-email@do-not-trust.com
        value:
          description: Spearphish Email Body
          type: string
          example: 'Content-Type: text/plain; charset=''utf-8''...'
      type: object
  parameters:
    Limit:
      name: limit
      in: query
      description: <br>The number of objects included in the response.
      required: false
      style: form
      explode: false
      schema:
        type: integer
        example: 10
    SpearphishWith:
      name: with
      in: query
      description: <br>Event Relationship that can be included in the response.
      required: false
      style: form
      explode: false
      schema:
        type: string
        example: event
    SpearphishId:
      name: spearphish_id
      in: path
      description: Spearphish ID
      required: true
      schema:
        type: integer
    EventId:
      name: event_id
      in: path
      description: Event ID
      required: true
      schema:
        type: integer
    Offset:
      name: offset
      in: query
      description: <br>The number of result set records that should be ignored.
      required: false
      style: form
      explode: false
      schema:
        type: integer
        example: 50
    Sort:
      name: sort
      in: query
      description: "<br>Designate the field(s) you want to use to sort the retrieved list. You can prepend each field \n        with a minus sign (-) to reverse the sorting order. This string can be a list of comma-separated values."
      required: false
      style: form
      explode: false
      schema:
        type: string
        example: id,created_at
  securitySchemes:
    BearerAuth:
      type: http
      description: "Once authorized, all subsequent requests must include an `Authorization` header\n with the granted `access_token`. See the OAuth2 Authentication path for more information on how to authorize a User.<br><br>\n Example Header: `Authorization: Bearer <access_token>`"
      name: Authorization
      in: header
      bearerFormat: Bearer `<access_token>`
      scheme: bearer