GoodLeads Services API

openapi: 3.2.0
info:
  title: Formation GTM Services API
  description: GoodLeads Formation Data Platform — scored, enriched, campaign-ready leads.
  version: 0.1.0
tags:
- name: Services
paths:
  /api/v1/services/summary:
    get:
      tags:
      - Services
      summary: Formation Service Summary
      description: Formation service attribution counts by state — the SLA view.
      operationId: formation_service_summary_api_v1_services_summary_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /api/v1/services/registry:
    get:
      tags:
      - Services
      summary: Formation Service Registry
      description: The full attribution registry — every RA name mapping with evidence.
      operationId: formation_service_registry_api_v1_services_registry_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /api/v1/services/coverage:
    get:
      tags:
      - Services
      summary: Formation Service Coverage
      description: Attribution coverage — what % of formations can we identify by service.
      operationId: formation_service_coverage_api_v1_services_coverage_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /api/v1/services/graph:
    get:
      tags:
      - Services
      summary: Formation Service Graph
      description: 'Commercial-agent-path filings as graph rows: the agent with its address and

        attribution, the business and mailing addresses, and every person linked to the

        filing with their own filed address and filer verdict. A read — the admin or

        the read-only key (it reveals people).'
      operationId: formation_service_graph_api_v1_services_graph_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: state
        in: query
        required: true
        schema:
          type: string
          minLength: 2
          maxLength: 2
          description: One state per call, e.g. FL
          title: State
        description: One state per call, e.g. FL
      - name: after
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Pass the previous page's next_after to continue
          title: After
        description: Pass the previous page's next_after to continue
      - name: page_size
        in: query
        required: false
        schema:
          type: integer
          maximum: 500
          minimum: 1
          default: 200
          title: Page Size
      - name: path
        in: query
        required: false
        schema:
          type: string
          pattern: ^(commercial|repeat_agent)$
          description: 'commercial (default): filings through a commercial agent. repeat_agent: filings whose non-commercial agent is named on two or more filings in the state.'
          default: commercial
          title: Path
        description: 'commercial (default): filings through a commercial agent. repeat_agent: filings whose non-commercial agent is named on two or more filings in the state.'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/services/mass-filers:
    get:
      tags:
      - Services
      summary: Formation Service Mass Filers
      description: 'What the nightly mass-filing sweep decided (ADR-120 Amendment 1): the agents

        held as mass filings and the agents on the review list, each with the marks

        that put it there. Shown under "Last night" on Formation Services. A read —

        the admin or the read-only key (it names agents, some of them people).'
      operationId: formation_service_mass_filers_api_v1_services_mass_filers_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: state
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            minLength: 2
            maxLength: 2
          - type: 'null'
          title: State
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/services/ledger:
    get:
      tags:
      - Services
      summary: Formation Service Ledger
      description: 'The nightly formation-service outcome ledger (Formation-Service Brain, Phase A):

        per state (US = national) and per intermediary on the commercial-agent path —

        records, held, looked up, found, and whether the contact is a person the filing

        names. A read — the admin or the read-only key (it names agents, some of them people).


        Response: ``{night, rule_version, rows: [...]}``, or ``{night: null, rows: []}`` before

        the first night; each row''s counts and rates are the contract in

        docs/reference/API_ENDPOINTS.md (``/api/v1/services/ledger``).'
      operationId: formation_service_ledger_api_v1_services_ledger_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: state
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            minLength: 2
            maxLength: 2
          - type: 'null'
          title: State
      - name: night
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: YYYY-MM-DD; default the latest night
          title: Night
        description: YYYY-MM-DD; default the latest night
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/services/brain:
    get:
      tags:
      - Services
      summary: Formation Service Brain
      description: 'The Formation-Service Brain''s nightly graph snapshot (Phase A): per scope

        (NAT = national, or a state) the intermediaries, agent desks, shared business

        addresses, filers and flow counts the Services-brain page renders. Built once a

        night; this read never touches the per-filing graph. The admin or the read-only

        key (it names agents, some of them people).


        Response: ``{night, rule_version, computed_at, scopes: {SCOPE: payload}, status}``, or

        ``{night: null, scopes: {}, status}`` before the first finished night; ``status`` is the

        newest build attempt. With ``demo=1`` the payload carries no person''s name or initials and

        no business list that would identify an owner. The payload''s fields are the contract in

        docs/reference/API_ENDPOINTS.md (``/api/v1/services/brain``).'
      operationId: formation_service_brain_api_v1_services_brain_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: scope
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            minLength: 2
            maxLength: 3
          - type: 'null'
          description: NAT or a state; default every scope
          title: Scope
        description: NAT or a state; default every scope
      - name: night
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: YYYY-MM-DD; default the latest night
          title: Night
        description: YYYY-MM-DD; default the latest night
      - name: demo
        in: query
        required: false
        schema:
          type: boolean
          description: Strip every person's name and initials (safe on a prospect's screen)
          default: false
          title: Demo
        description: Strip every person's name and initials (safe on a prospect's screen)
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/services/{service}/entities:
    get:
      tags:
      - Services
      summary: Formation Service Entities
      description: 'Drill-down: entities attributed to a formation service.'
      operationId: formation_service_entities_api_v1_services__service__entities_get
      parameters:
      - name: service
        in: path
        required: true
        schema:
          type: string
          title: Service
      - name: state
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: State
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          default: 1
          title: Page
      - name: page_size
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          default: 25
          title: Page Size
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/services/ra-names:
    get:
      tags:
      - Services
      summary: Formation Service Ra Names
      description: All matched RA names with actual formation counts.
      operationId: formation_service_ra_names_api_v1_services_ra_names_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /api/v1/services/address-clusters:
    get:
      tags:
      - Services
      summary: Formation Service Address Clusters
      description: RA address clustering — which physical addresses do formation services use?
      operationId: formation_service_address_clusters_api_v1_services_address_clusters_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key