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

# Check job status

> Return job-owned state; only a published immutable result can be done.



## OpenAPI

````yaml https://api.firmintent.com/openapi.json get /v1/jobs/{job_id}
openapi: 3.1.0
info:
  title: firmintent API
  description: >

    Give firmintent a **LinkedIn company and persona** — get back the **right
    people**.


    You submit a company — a **LinkedIn company URL** (`…/company/<slug-or-id>`)
    or a **bare numeric

    company id**; we scan and broadly enrich its roster, find likely persona
    candidates, verify the

    shortlist, and return a ranked target list. (Bare name/domain lookup is a
    later layer — not accepted

    yet.) Jobs run

    **asynchronously** (minutes) — you either poll `GET /v1/jobs/{id}` or
    receive a **webhook**.


    All endpoints are versioned under **`/v1`**. Pin the version; new fields are
    added within `/v1`,

    breaking changes ship under a new `/vN`.


    ### Authentication

    Every request needs an API key in the `X-API-Key` header. Generate yours in
    the

    [dashboard](https://app.firmintent.com/dashboard). `POST /v1/jobs` spends
    money, so it

    is never anonymous.


    ### The flow — two calls

    1. `POST /v1/jobs` `{ "input": "linkedin.com/company/<slug>", "operation":
    "target_people", "persona": "owners-founders" }` → `202 { job_id }`

    2. Poll `GET /v1/jobs/{job_id}` until `status: "done"` — that response
    contains
       `target_people[]` inline. No third call.

    Re-polling a finished job returns the same result (idempotent, already paid
    for), so a lost response

    never costs a new job.


    ### Webhook (optional — instead of polling)

    Pass `callback_url` on `POST /v1/jobs`. When the job is done we `POST` that
    URL with the full result:

    `{ job_id, company_id, company, status: "done", target_people_count,
    target_people[] }`. You just need

    an HTTPS endpoint on your side that returns `2xx`.
  contact:
    name: firmintent
    url: https://firmintent.com/
  version: 1.0.0
servers:
  - url: https://api.firmintent.com
    description: Production
security: []
tags:
  - name: jobs
    description: Submit and track target-people jobs.
  - name: account
    description: Your credit balance, tier and usage.
  - name: personas
    description: Saved target audiences used by persona-first jobs.
paths:
  /v1/jobs/{job_id}:
    get:
      tags:
        - jobs
      summary: Check job status
      description: Return job-owned state; only a published immutable result can be done.
      operationId: get_job_v1_jobs__job_id__get
      parameters:
        - name: job_id
          in: path
          required: true
          schema:
            type: string
            title: Job Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobStatus'
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Job not found (or not yours).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
components:
  schemas:
    JobStatus:
      properties:
        job_id:
          type: string
          title: Job Id
        status:
          type: string
          enum:
            - processing
            - done
            - not_found
            - no_employees
            - no_people_found
            - too_large
            - failed
            - cancelled
          title: Status
          description: >-
            `processing` | `done` | `not_found` | `no_employees` |
            `no_people_found` | `too_large` | `failed` | `cancelled`.
          examples:
            - done
        processing_state:
          anyOf:
            - type: string
              enum:
                - active
                - delayed
            - type: 'null'
          title: Processing State
          description: '`active` or `delayed` while status=processing.'
        stage:
          anyOf:
            - type: string
              enum:
                - match_company
                - scan_team
                - enrich_profiles
                - find_candidates
                - verify_candidates
                - match_target
            - type: 'null'
          title: Stage
          description: Current canonical pipeline stage.
        next_retry_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Retry At
          description: ISO timestamp for a delayed automatic retry.
        message:
          anyOf:
            - type: string
            - type: 'null'
          title: Message
          description: >-
            Human-readable explanation for a terminal state that needs one —
            e.g. why a `too_large` company was not searched. null otherwise.
          examples:
            - Companies over 100 employees are available on premium plans.
        company_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Company Id
          examples:
            - 3384253
        company:
          anyOf:
            - $ref: '#/components/schemas/Company'
            - type: 'null'
          description: Shared company context, present on done.
        persona:
          anyOf:
            - $ref: '#/components/schemas/AppliedPersona'
            - type: 'null'
          description: The immutable persona snapshot used by this job.
        team_scanned:
          anyOf:
            - type: integer
            - type: 'null'
          title: Team Scanned
        profiles_enriched:
          anyOf:
            - type: integer
            - type: 'null'
          title: Profiles Enriched
        preliminary_candidates:
          anyOf:
            - type: integer
            - type: 'null'
          title: Preliminary Candidates
        target_people_count:
          anyOf:
            - type: integer
            - type: 'null'
          title: Target People Count
        target_people:
          anyOf:
            - items:
                $ref: '#/components/schemas/TargetPerson'
              type: array
            - type: 'null'
          title: Target People
          description: Final ranked persona matches, present only on done.
        credits_charged:
          type: integer
          enum:
            - 0
            - 1
          title: Credits Charged
          description: >-
            Actual numeric charge so far; 0 until/free, 1 after successful
            metered settlement.
          default: 0
          examples:
            - 1
        credits_balance:
          anyOf:
            - type: integer
            - type: 'null'
          title: Credits Balance
          description: >-
            Your remaining credit balance after this job. Present on `done` for
            metered keys.
          examples:
            - 7
      type: object
      required:
        - job_id
        - status
      title: JobStatus
      description: Poll response. On `done` final target people are returned inline.
    ErrorResponse:
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
      type: object
      required:
        - error
      title: ErrorResponse
      description: >-
        Every non-2xx response has this shape: a single `error` object.
        Consistent across all status codes.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    Company:
      properties:
        id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Id
          examples:
            - 3384253
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        linkedin_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Linkedin Url
        website:
          anyOf:
            - type: string
            - type: 'null'
          title: Website
        domain:
          anyOf:
            - type: string
            - type: 'null'
          title: Domain
        industry:
          anyOf:
            - type: string
            - type: 'null'
          title: Industry
        type:
          anyOf:
            - type: string
            - type: 'null'
          title: Type
          examples:
            - Privately Held
        employees_count:
          anyOf:
            - type: integer
            - type: 'null'
          title: Employees Count
        linkedin_since_est:
          anyOf:
            - type: string
            - type: 'null'
          title: Linkedin Since Est
          description: >-
            Estimated LinkedIn-since (computed from company_id): 'YYYY-MM' |
            'YYYY-Qn' | 'YYYY' | 'before 2022'.
          examples:
            - 2023-11
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        slogan:
          anyOf:
            - type: string
            - type: 'null'
          title: Slogan
        specialties:
          items:
            type: string
          type: array
          title: Specialties
          description: Self-declared focus/tech areas (Page-admin free text).
        location:
          $ref: '#/components/schemas/CompanyLocation'
        followers:
          anyOf:
            - type: integer
            - type: 'null'
          title: Followers
        last_post_date:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Post Date
        company_language:
          anyOf:
            - type: string
              pattern: ^[a-z]{2}$
            - type: 'null'
          title: Company Language
          description: >-
            ISO 639-1 code of the company's public language (from
            description/slogan/posts).
          examples:
            - en
        hiring_for:
          items:
            type: string
          type: array
          title: Hiring For
        logo_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Logo Url
        has_logo:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Has Logo
        recent_posts:
          items:
            $ref: '#/components/schemas/CompanyPost'
          type: array
          title: Recent Posts
      type: object
      title: Company
    AppliedPersona:
      properties:
        slug:
          type: string
          title: Slug
          examples:
            - owners-founders
        name:
          type: string
          title: Name
          examples:
            - Owners & founders
      type: object
      required:
        - slug
        - name
      title: AppliedPersona
      description: >-
        The persona that filtered this job — echoed back so the caller knows
        which target produced the

        result (informative; the full definition lives in `GET /v1/personas`).
    TargetPerson:
      properties:
        rank_in_company:
          type: integer
          minimum: 1
          title: Rank In Company
          description: 'Outreach priority: 1 = contact first.'
        is_decision_maker:
          type: boolean
          title: Is Decision Maker
        why:
          type: string
          maxLength: 1000
          minLength: 1
          title: Why
          description: >-
            Why this person matches the selected persona and belongs at this
            rank.
        person:
          $ref: '#/components/schemas/Person'
        professional:
          $ref: '#/components/schemas/Professional'
        contact:
          $ref: '#/components/schemas/Contact'
        experience:
          items:
            $ref: '#/components/schemas/ExperienceItem'
          type: array
          title: Experience
        education:
          items:
            $ref: '#/components/schemas/EducationItem'
          type: array
          title: Education
        signals:
          $ref: '#/components/schemas/Signals'
        meta:
          $ref: '#/components/schemas/Meta'
      additionalProperties: false
      type: object
      required:
        - rank_in_company
        - is_decision_maker
        - why
      title: TargetPerson
      description: >-
        A final persona match. The list itself implies target_match=true, so

        the response deliberately carries no redundant match/fit/evidence
        blocks.
    ErrorDetail:
      properties:
        code:
          type: string
          title: Code
          description: Stable machine-readable error code.
          examples:
            - insufficient_credits
        message:
          type: string
          title: Message
          description: Human-readable explanation.
          examples:
            - You're out of credits. Top up to run jobs.
        balance:
          anyOf:
            - type: integer
            - type: 'null'
          title: Balance
          description: Your current credit balance (present on credit errors).
        limit:
          anyOf:
            - type: integer
            - type: 'null'
          title: Limit
          description: Your plan's concurrency limit (present on concurrency errors).
      type: object
      required:
        - code
        - message
      title: ErrorDetail
      description: >-
        A single error. Branch on `code` (stable, machine-readable) — never on
        `message` (human text that

        may change). Extra fields carry context: `balance` on credit errors,
        `limit` on concurrency errors.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    CompanyLocation:
      properties:
        locality:
          anyOf:
            - type: string
            - type: 'null'
          title: Locality
        region:
          anyOf:
            - type: string
            - type: 'null'
          title: Region
        country:
          anyOf:
            - type: string
            - type: 'null'
          title: Country
          description: Country name (resolved from the ISO code).
          examples:
            - Argentina
        country_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Country Code
          description: ISO 3166-1 alpha-2 country code.
          examples:
            - AR
        postal_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Postal Code
      type: object
      title: CompanyLocation
    CompanyPost:
      properties:
        content:
          anyOf:
            - type: string
            - type: 'null'
          title: Content
        posted_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Posted At
        url:
          anyOf:
            - type: string
            - type: 'null'
          title: Url
      type: object
      title: CompanyPost
    Person:
      properties:
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
          examples:
            - Jane Doe
        first_name:
          anyOf:
            - type: string
            - type: 'null'
          title: First Name
        last_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Name
        headline:
          anyOf:
            - type: string
            - type: 'null'
          title: Headline
        linkedin_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Linkedin Url
          examples:
            - https://www.linkedin.com/in/jane-doe
        photo_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Photo Url
        background_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Background Url
          description: >-
            Their custom LinkedIn profile banner, if they set one (null = the
            default banner — most people; decision makers more often set one,
            sometimes with company branding).
        location:
          $ref: '#/components/schemas/PersonLocation'
        about:
          anyOf:
            - type: string
            - type: 'null'
          title: About
        connections:
          anyOf:
            - type: integer
            - type: 'null'
          title: Connections
        followers:
          anyOf:
            - type: integer
            - type: 'null'
          title: Followers
        member_since:
          anyOf:
            - type: string
            - type: 'null'
          title: Member Since
          description: Exact LinkedIn account registration date (ISO YYYY-MM-DD).
          examples:
            - '2011-07-27'
        gender:
          type: string
          enum:
            - male
            - female
            - unknown
          title: Gender
          description: male | female | unknown
          default: unknown
          examples:
            - female
        outreach_language:
          anyOf:
            - type: string
              pattern: ^[a-z]{2}$
            - type: 'null'
          title: Outreach Language
          description: >-
            ISO 639-1 code of the single best language to write outreach to this
            person in — the LLM's pick from their declared languages, LinkedIn
            locale, location, and own posts.
          examples:
            - en
        flags:
          $ref: '#/components/schemas/Flags'
        certifications:
          items:
            $ref: '#/components/schemas/Certification'
          type: array
          title: Certifications
        interests:
          $ref: '#/components/schemas/Interests'
        featured:
          items:
            $ref: '#/components/schemas/FeaturedItem'
          type: array
          title: Featured
          description: >-
            LinkedIn 'Featured' items the person pins to their profile — curated
            self-promotion (business links, talks, docs, awards).
      type: object
      title: Person
    Professional:
      properties:
        tier:
          anyOf:
            - type: string
              enum:
                - owner
                - executive
                - function_leader
                - manager
                - individual
            - type: 'null'
          title: Tier
        role:
          anyOf:
            - type: string
            - type: 'null'
          title: Role
        function:
          anyOf:
            - type: string
            - type: 'null'
          title: Function
        work_status:
          anyOf:
            - type: string
              enum:
                - employed
                - freelancer
                - student
                - not_working
                - unknown
            - type: 'null'
          title: Work Status
        belongs_to_company:
          anyOf:
            - type: string
              enum:
                - confirmed
                - likely
                - 'no'
            - type: 'null'
          title: Belongs To Company
        manages_people:
          anyOf:
            - type: string
              enum:
                - 'yes'
                - likely
                - 'no'
                - unknown
            - type: 'null'
          title: Manages People
        budget_authority:
          anyOf:
            - type: string
              enum:
                - owns
                - influences
                - none
                - unknown
            - type: 'null'
          title: Budget Authority
      type: object
      title: Professional
    Contact:
      properties:
        email:
          anyOf:
            - $ref: '#/components/schemas/EmailInfo'
            - type: 'null'
        websites:
          items:
            type: string
          type: array
          title: Websites
        bio_links:
          items:
            $ref: '#/components/schemas/BioLink'
          type: array
          title: Bio Links
      type: object
      title: Contact
    ExperienceItem:
      properties:
        title:
          anyOf:
            - type: string
            - type: 'null'
          title: Title
        company:
          anyOf:
            - type: string
            - type: 'null'
          title: Company
        company_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Company Id
        employment_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Employment Type
        workplace_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Workplace Type
        start:
          anyOf:
            - type: string
            - type: 'null'
          title: Start
        end:
          anyOf:
            - type: string
            - type: 'null'
          title: End
        duration:
          anyOf:
            - type: string
            - type: 'null'
          title: Duration
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
      type: object
      title: ExperienceItem
    EducationItem:
      properties:
        school:
          anyOf:
            - type: string
            - type: 'null'
          title: School
        degree:
          anyOf:
            - type: string
            - type: 'null'
          title: Degree
        field:
          anyOf:
            - type: string
            - type: 'null'
          title: Field
        start:
          anyOf:
            - type: string
            - type: 'null'
          title: Start
        end:
          anyOf:
            - type: string
            - type: 'null'
          title: End
      type: object
      title: EducationItem
    Signals:
      properties:
        recommendations_count:
          anyOf:
            - type: integer
            - type: 'null'
          title: Recommendations Count
        recommendations:
          items:
            $ref: '#/components/schemas/Recommendation'
          type: array
          title: Recommendations
        posts_about_own_company:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Posts About Own Company
        avg_engagement:
          anyOf:
            - type: number
            - type: 'null'
          title: Avg Engagement
        recent_posts:
          items:
            $ref: '#/components/schemas/RecentPost'
          type: array
          title: Recent Posts
        authored_articles:
          items:
            $ref: '#/components/schemas/Article'
          type: array
          title: Authored Articles
        last_active:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Active
          description: >-
            Date of their most recent post or reshare (ISO YYYY-MM-DD) — is the
            profile alive.
          examples:
            - '2026-06-20'
      type: object
      title: Signals
    Meta:
      properties:
        linkedin_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Linkedin Id
        profile_urn:
          anyOf:
            - type: string
            - type: 'null'
          title: Profile Urn
        has_real_photo:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Has Real Photo
        photo_uploaded_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Photo Uploaded At
          description: When the owner last changed their photo.
        photo_expires_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Photo Expires At
          description: When the signed image URL expires (null = permanent).
      type: object
      title: Meta
    PersonLocation:
      properties:
        text:
          anyOf:
            - type: string
            - type: 'null'
          title: Text
          description: Display location line (LinkedIn's own text).
          examples:
            - Glendale, California, United States
        city:
          anyOf:
            - type: string
            - type: 'null'
          title: City
          examples:
            - Glendale
        region:
          anyOf:
            - type: string
            - type: 'null'
          title: Region
          description: State / province / region.
          examples:
            - California
        country:
          anyOf:
            - type: string
            - type: 'null'
          title: Country
          description: Country name.
          examples:
            - United States
        country_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Country Code
          description: ISO 3166-1 alpha-2 country code.
          examples:
            - US
      type: object
      title: PersonLocation
      description: >-
        Where the person is — structured, not a flat string. `text` is the
        display line (always present);

        `city`/`region`/`country`/`country_code` come from the harvestapi
        geo-parse (null on sources that

        only give raw text, e.g. a BrightData-only profile). Mirrors
        CompanyLocation so both are queryable.
    Flags:
      properties:
        open_to_work:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Open To Work
        hiring:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Hiring
        premium:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Premium
        verified:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Verified
        influencer:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Influencer
        creator:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Creator
      type: object
      title: Flags
    Certification:
      properties:
        title:
          anyOf:
            - type: string
            - type: 'null'
          title: Title
        issued_by:
          anyOf:
            - type: string
            - type: 'null'
          title: Issued By
      type: object
      title: Certification
    Interests:
      properties:
        groups:
          items:
            $ref: '#/components/schemas/InterestGroup'
          type: array
          title: Groups
        newsletters:
          items:
            $ref: '#/components/schemas/InterestNewsletter'
          type: array
          title: Newsletters
      type: object
      title: Interests
      description: >-
        What the person follows on LinkedIn — a topical/qualification signal.
        Groups reveal a professional

        niche; newsletters reveal a current topical interest. Up to 3 of each.
    FeaturedItem:
      properties:
        title:
          anyOf:
            - type: string
            - type: 'null'
          title: Title
          examples:
            - Argentina Travel Agency
        subtitle:
          anyOf:
            - type: string
            - type: 'null'
          title: Subtitle
          description: Source / domain of the featured item.
          examples:
            - 01argentina.travel
        type:
          anyOf:
            - type: string
            - type: 'null'
          title: Type
          description: LINK | IMAGE | DOCUMENT | POST | … (from LinkedIn).
          examples:
            - LINK
        url:
          anyOf:
            - type: string
            - type: 'null'
          title: Url
          description: LinkedIn overlay link to the featured item.
      type: object
      title: FeaturedItem
      description: >-
        One item from the person's LinkedIn 'Featured' section — content they
        PIN to the top of their

        profile (their business site, a talk, a document, an award). Curated
        self-promotion: a strong

        outreach hook and a seniority signal. `subtitle` usually names the
        source/domain; `url` is a

        LinkedIn overlay link to the item (not the raw external destination).
    EmailInfo:
      properties:
        address:
          anyOf:
            - type: string
            - type: 'null'
          title: Address
          examples:
            - jane@acme.com
        status:
          anyOf:
            - type: string
            - type: 'null'
          title: Status
          description: valid | risky | invalid
          examples:
            - valid
        quality_score:
          anyOf:
            - type: integer
            - type: 'null'
          title: Quality Score
          examples:
            - 92
        catch_all_domain:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Catch All Domain
        valid_email_server:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Valid Email Server
        free:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Free
        source:
          anyOf:
            - type: string
            - type: 'null'
          title: Source
          description: verified (findEmail SMTP) | guessed (pattern on catch-all)
          examples:
            - verified
      type: object
      title: EmailInfo
    BioLink:
      properties:
        url:
          anyOf:
            - type: string
            - type: 'null'
          title: Url
        title:
          anyOf:
            - type: string
            - type: 'null'
          title: Title
      type: object
      title: BioLink
    Recommendation:
      properties:
        by:
          anyOf:
            - type: string
            - type: 'null'
          title: By
        by_headline:
          anyOf:
            - type: string
            - type: 'null'
          title: By Headline
        text:
          anyOf:
            - type: string
            - type: 'null'
          title: Text
      type: object
      title: Recommendation
    RecentPost:
      properties:
        content:
          anyOf:
            - type: string
            - type: 'null'
          title: Content
        posted_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Posted At
        url:
          anyOf:
            - type: string
            - type: 'null'
          title: Url
        is_repost:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Repost
        engagement:
          $ref: '#/components/schemas/Engagement'
      type: object
      title: RecentPost
    Article:
      properties:
        title:
          anyOf:
            - type: string
            - type: 'null'
          title: Title
        link:
          anyOf:
            - type: string
            - type: 'null'
          title: Link
        published:
          anyOf:
            - type: string
            - type: 'null'
          title: Published
      type: object
      title: Article
    InterestGroup:
      properties:
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        url:
          anyOf:
            - type: string
            - type: 'null'
          title: Url
          examples:
            - https://www.linkedin.com/groups/2124257
        members:
          anyOf:
            - type: integer
            - type: 'null'
          title: Members
          description: Group size (member count).
          examples:
            - 137932
      type: object
      title: InterestGroup
    InterestNewsletter:
      properties:
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        about:
          anyOf:
            - type: string
            - type: 'null'
          title: About
          description: Newsletter description.
        cadence:
          anyOf:
            - type: string
            - type: 'null'
          title: Cadence
          description: daily | weekly | biweekly | monthly
          examples:
            - monthly
      type: object
      title: InterestNewsletter
    Engagement:
      properties:
        likes:
          anyOf:
            - type: integer
            - type: 'null'
          title: Likes
        comments:
          anyOf:
            - type: integer
            - type: 'null'
          title: Comments
        shares:
          anyOf:
            - type: integer
            - type: 'null'
          title: Shares
      type: object
      title: Engagement
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      description: Your brk_live_ API key.
      in: header
      name: X-API-Key

````