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

# Generate synthetic contact data

> Generates synthetic contact information including email addresses, website URLs, optional phone numbers, optional account identifiers, display names, and optional social profile URLs for testing contact workflows. Supports reserved example-domain email output, custom email domains, optional special characters in email local parts, and selectable phone number styles.



## OpenAPI

````yaml https://apix.spotzee.com/api/ext/openapi.json post /generic/data/generate/contact
openapi: 3.1.0
info:
  title: Spotzee API
  version: '2026-04-28'
  description: >-
    Comprehensive API for email services, DNS management, AI tools, and
    marketing features.
servers:
  - url: https://apix.spotzee.com/api/ext
    description: >-
      Extended API surface — sender-side utilities (DNS, AI, deliverability,
      generators).
security:
  - BearerAuth: []
tags:
  - name: AI
    description: >-
      Sender-side AI utilities — generate copy, score subject lines, and draft
      message variants tailored to a contact or campaign brief.
  - name: Data
    description: >-
      Realistic-looking sample data for development and load testing — contacts,
      events, and segments shaped like production records without exposing real
      customer data.
  - name: DNS
    description: >-
      Inspect a domain’s sender posture — SPF, DKIM, DMARC, MX, and reverse-DNS
      records — and surface the gaps that put deliverability at risk.
  - name: Email
    description: >-
      Send-side validation and inspection — verify addresses, fingerprint MTAs,
      decode bounces, and check inbox-placement signals before a campaign goes
      out.
  - name: SMS
    description: Mobile-number validation and carrier lookup for SMS campaigns.
  - name: Text
    description: >-
      Text-quality utilities — spam-score grading, readability metrics, and
      subject-line scoring against deliverability heuristics.
paths:
  /generic/data/generate/contact:
    post:
      tags:
        - Data
      summary: Generate synthetic contact data
      description: >-
        Generates synthetic contact information including email addresses,
        website URLs, optional phone numbers, optional account identifiers,
        display names, and optional social profile URLs for testing contact
        workflows. Supports reserved example-domain email output, custom email
        domains, optional special characters in email local parts, and
        selectable phone number styles.
      operationId: generateContactData
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                count:
                  type: string
                  description: >-
                    Number of contacts to generate (1-100). Passed as string but
                    must be numeric.
                  example: '10'
                  pattern: ^[1-9]\d?$|^100$
                locale:
                  type: string
                  description: >-
                    Locale for generated data (for example, en, es, fr, de, pt,
                    zh)
                  example: en
                seed:
                  type: string
                  description: >-
                    Seed for deterministic generation. Same seed produces same
                    results.
                  example: '12345'
                includePhone:
                  type: string
                  description: Include a generated phone number on each contact.
                  example: 'true'
                  enum:
                    - 'true'
                    - 'false'
                includeSocial:
                  type: string
                  description: Include generated social profile URLs on each contact.
                  example: 'false'
                  enum:
                    - 'true'
                    - 'false'
                includeAccount:
                  type: string
                  description: >-
                    Include generated username and display-name fields on each
                    contact.
                  example: 'false'
                  enum:
                    - 'true'
                    - 'false'
                useExampleEmail:
                  type: string
                  description: >-
                    Use reserved example email domains for generated email
                    addresses.
                  example: 'false'
                  enum:
                    - 'true'
                    - 'false'
                allowSpecialCharacters:
                  type: string
                  description: Allow special characters in generated email local parts.
                  example: 'false'
                  enum:
                    - 'true'
                    - 'false'
                phoneStyle:
                  type: string
                  description: Phone number style when includePhone is true.
                  example: international
                  enum:
                    - human
                    - national
                    - international
                emailDomain:
                  type: string
                  description: >-
                    Domain to use for generated email addresses. Do not combine
                    with useExampleEmail=true.
                  example: example.com
      responses:
        '200':
          description: Successfully generated contact data
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - success
                  data:
                    type: object
                    properties:
                      contacts:
                        type: array
                        items:
                          type: object
                          properties:
                            email:
                              type: string
                            website:
                              type: string
                            phone:
                              type: string
                            username:
                              type: string
                            displayName:
                              type: string
                            social:
                              type: object
                              properties:
                                twitter:
                                  type: string
                                linkedin:
                                  type: string
                                github:
                                  type: string
                          required:
                            - email
                            - website
                      generated:
                        type: number
                      locale:
                        type: string
                      seed:
                        type: number
                    required:
                      - contacts
                      - generated
                      - locale
                  performance:
                    type: object
                    properties:
                      generationTime:
                        type: number
                        description: Generation time in milliseconds.
                        example: 2
                      itemsGenerated:
                        type: number
                        description: Number of items generated.
                        example: 10
                      locale:
                        type: string
                        description: Locale used for generation.
                        example: en
                    required:
                      - generationTime
                      - itemsGenerated
                      - locale
                required:
                  - status
                  - data
                example:
                  status: success
                  data:
                    contacts:
                      - email: jane.smith@company.com
                        website: https://example.com
                        phone: +1-555-987-6543
                        username: jane.smith
                        displayName: Jane_Smith
                    generated: 1
                    locale: en
                    seed: 12345
                  performance:
                    generationTime: 2
                    itemsGenerated: 1
                    locale: en
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - error
                    description: Indicates an error occurred
                  error:
                    type: string
                    description: >-
                      Human-readable error message. Mirrors the Main API
                      envelope’s legacy `error` field; the canonical replacement
                      is `message` + machine-readable `code` (see
                      @spotzee/api-schemas/shared `ErrorResponse`).
                    example: Invalid request parameters
                required:
                  - status
                  - error
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - error
                    description: Indicates an error occurred
                  error:
                    type: string
                    description: >-
                      Human-readable error message. Mirrors the Main API
                      envelope’s legacy `error` field; the canonical replacement
                      is `message` + machine-readable `code` (see
                      @spotzee/api-schemas/shared `ErrorResponse`).
                    example: Invalid request parameters
                required:
                  - status
                  - error
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - error
                    description: Indicates an error occurred
                  error:
                    type: string
                    description: >-
                      Human-readable error message. Mirrors the Main API
                      envelope’s legacy `error` field; the canonical replacement
                      is `message` + machine-readable `code` (see
                      @spotzee/api-schemas/shared `ErrorResponse`).
                    example: Invalid request parameters
                required:
                  - status
                  - error
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - error
                    description: Indicates an error occurred
                  error:
                    type: string
                    description: >-
                      Human-readable error message. Mirrors the Main API
                      envelope’s legacy `error` field; the canonical replacement
                      is `message` + machine-readable `code` (see
                      @spotzee/api-schemas/shared `ErrorResponse`).
                    example: Invalid request parameters
                required:
                  - status
                  - error
        '503':
          description: Service unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - error
                    description: Indicates an error occurred
                  error:
                    type: string
                    description: >-
                      Human-readable error message. Mirrors the Main API
                      envelope’s legacy `error` field; the canonical replacement
                      is `message` + machine-readable `code` (see
                      @spotzee/api-schemas/shared `ErrorResponse`).
                    example: Invalid request parameters
                required:
                  - status
                  - error
      security:
        - BearerAuth: []
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: 'Bearer token authentication. Use format: Bearer YOUR_API_KEY'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.