ASAP Sourcing API

openapi: 3.2.0
info:
  title: ASAP Platform Sourcing API
  description: 'Public HTTP API for ASAP Platform (api.asap.cool).


    All `/v1` responses are wrapped in a standard envelope. Success responses are `{ "data": , "meta": { "request_id", "next_cursor"?, "has_more"? } }` — the schema documented for each operation describes the inner `data` value. Errors are `{ "error": { "code", "message", "field"?, "request_id" } }`. Every response also carries an `X-Request-Id` header matching `meta.request_id` / `error.request_id`.'
  license:
    name: BUSL-1.1
  version: 0.0.0
servers:
- url: https://api.asap.cool
  description: Production
tags:
- name: sourcing
paths:
  /v1/sourcing/leads:
    get:
      tags:
      - sourcing
      summary: GET /v1/sourcing/leads
      operationId: listSourcingLeads
      parameters:
      - name: limit
        in: query
        description: Page size, 1..=100 (defaults to 50).
        required: false
        schema:
          type:
          - integer
          - 'null'
          format: int32
          minimum: 0
      - name: cursor
        in: query
        description: Opaque cursor from a previous page's `meta.next_cursor`.
        required: false
        schema:
          type:
          - string
          - 'null'
      - name: status
        in: query
        description: Filter by lead status (`new` / `converted` / `dismissed`).
        required: false
        schema:
          type:
          - string
          - 'null'
      - name: run_id
        in: query
        description: Restrict to leads fed by a given scrape run.
        required: false
        schema:
          type:
          - string
          - 'null'
          format: uuid
      responses:
        '200':
          description: Page of leads (newest first).
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LeadView'
        '401':
          description: No active org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: Missing sourcing:read scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '422':
          description: Invalid limit, cursor, or status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - session: []
      - api_key:
        - sourcing:leads_read
  /v1/sourcing/leads/convert:
    post:
      tags:
      - sourcing
      summary: POST /v1/sourcing/leads/convert
      operationId: convertSourcingLeads
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConvertRequest'
        required: true
      responses:
        '200':
          description: Conversion outcome per lead.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConvertResult'
        '401':
          description: No active org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: Missing sourcing:write scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - session: []
  /v1/sourcing/leads/dismiss:
    post:
      tags:
      - sourcing
      summary: POST /v1/sourcing/leads/dismiss
      operationId: dismissSourcingLeads
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DismissRequest'
        required: true
      responses:
        '200':
          description: Number of leads dismissed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DismissResult'
        '401':
          description: No active org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: Missing sourcing:write scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - session: []
  /v1/sourcing/runs:
    get:
      tags:
      - sourcing
      summary: GET /v1/sourcing/runs
      operationId: listSourcingRuns
      responses:
        '200':
          description: Scrape runs (newest first).
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ScrapeRunView'
        '401':
          description: No active org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: Missing sourcing:read scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - session: []
      - api_key:
        - sourcing:leads_read
    post:
      tags:
      - sourcing
      summary: POST /v1/sourcing/runs
      operationId: createSourcingRun
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateScrapeRunRequest'
        required: true
      responses:
        '200':
          description: Scrape run created (pending).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScrapeRunView'
        '401':
          description: No active org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: Missing sourcing:write scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '422':
          description: Invalid payload.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - session: []
  /v1/sourcing/runs/{id}:
    get:
      tags:
      - sourcing
      summary: GET /v1/sourcing/runs/{id}
      operationId: getSourcingRun
      parameters:
      - name: id
        in: path
        description: Scrape run identifier.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Scrape run.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScrapeRunView'
        '401':
          description: No active org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: Missing sourcing:read scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '404':
          description: Not found or cross-org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - session: []
      - api_key:
        - sourcing:leads_read
components:
  schemas:
    DismissRequest:
      type: object
      description: Body of `POST /v1/sourcing/leads/dismiss`.
      required:
      - lead_ids
      properties:
        lead_ids:
          type: array
          items:
            type: string
            format: uuid
          description: Leads to dismiss. Already-converted leads are left untouched.
    DismissResult:
      type: object
      description: Response for `POST /v1/sourcing/leads/dismiss`.
      required:
      - dismissed
      properties:
        dismissed:
          type: integer
          format: int64
          description: Number of leads whose status changed to `dismissed`.
          minimum: 0
    CreateScrapeRunRequest:
      type: object
      description: Body of `POST /v1/sourcing/runs`. `org_id` is never accepted here.
      required:
      - niche
      - city
      properties:
        city:
          type: string
          description: French city or postal area (e.g. "Lyon 7e").
        limit:
          type:
          - integer
          - 'null'
          format: int32
          description: 'Upper bound on how many places to collect (defaults to the domain

            [`DEFAULT_LIMIT`], clamped to the domain maximum).'
          minimum: 0
        niche:
          type: string
          description: Niche / vertical query (e.g. "plombier").
    LeadView:
      type: object
      description: Public projection of a `sourcing.lead` for the leads inbox.
      required:
      - id
      - company
      - maps_url
      - status
      - created_at
      properties:
        city:
          type:
          - string
          - 'null'
          description: City, when parsed.
        company:
          type: string
          description: Business name.
        contact_id:
          type:
          - string
          - 'null'
          format: uuid
          description: Linked contact once converted.
        created_at:
          type: string
          description: Creation timestamp (RFC3339).
        forme_juridique:
          type:
          - string
          - 'null'
          description: Legal form resolved alongside the SIREN, when mappable.
        id:
          type: string
          format: uuid
          description: Stable identifier.
        maps_url:
          type: string
          description: Canonical Maps URL.
        phone:
          type:
          - string
          - 'null'
          description: Normalised phone, when known.
        rating:
          type:
          - number
          - 'null'
          format: double
          description: Star rating, when present.
        reviews_count:
          type:
          - integer
          - 'null'
          format: int64
          description: Number of reviews, when present.
        siren:
          type:
          - string
          - 'null'
          description: SIREN resolved by the enrichment pass, when confidently matched.
        status:
          type: string
          description: Lifecycle status (`new` / `converted` / `dismissed`).
        website:
          type:
          - string
          - 'null'
          description: Website URL, when listed.
    ConvertRequest:
      type: object
      description: Body of `POST /v1/sourcing/leads/convert`.
      required:
      - lead_ids
      properties:
        lead_ids:
          type: array
          items:
            type: string
            format: uuid
          description: Leads to convert. Unknown / cross-org ids are silently ignored.
    ErrorBody:
      type: object
      description: 'Generic error body returned by API handlers when they fail. `code` is a

        stable machine-readable token; `message` is human-friendly and meant for

        surfacing to end users.'
      required:
      - code
      - message
      properties:
        code:
          type: string
          description: Stable machine token (e.g. `invalid_credentials`).
        field:
          type:
          - string
          - 'null'
          description: Offending request field for validation errors, when known.
        message:
          type: string
          description: Human-readable message.
    ConvertedLead:
      type: object
      description: One converted lead and the contact it now points at.
      required:
      - lead_id
      - contact_id
      properties:
        contact_id:
          type: string
          format: uuid
          description: The contact it was materialised into or attached to.
        lead_id:
          type: string
          format: uuid
          description: The lead that was converted.
    SkippedLead:
      type: object
      description: One lead skipped during conversion, with the reason.
      required:
      - lead_id
      - reason
      properties:
        contact_id:
          type:
          - string
          - 'null'
          format: uuid
          description: 'The contact this lead already points at — set only for

            `already_converted`, so a replay can still link to the contact.'
        lead_id:
          type: string
          format: uuid
          description: The lead that was skipped.
        reason:
          type: string
          description: Why it was skipped (`already_converted` / `quota_reached`).
    ConvertResult:
      type: object
      description: Response for `POST /v1/sourcing/leads/convert`.
      required:
      - converted
      - skipped
      properties:
        converted:
          type: array
          items:
            $ref: '#/components/schemas/ConvertedLead'
          description: Leads materialised or attached to a contact.
        skipped:
          type: array
          items:
            $ref: '#/components/schemas/SkippedLead'
          description: Leads left untouched, with the reason.
    ScrapeRunView:
      type: object
      description: Public projection of a [`ScrapeRun`], including its raw-result tallies.
      required:
      - id
      - niche
      - city
      - limit
      - status
      - created_at
      - discovered
      - ingested
      - failed
      properties:
        city:
          type: string
          description: French city or postal area.
        created_at:
          type: string
          description: Creation timestamp (RFC3339).
        discovered:
          type: integer
          format: int64
          description: Total raw results discovered for the run.
        failed:
          type: integer
          format: int64
          description: Raw results that failed normalisation (`status = 'failed'`).
        id:
          type: string
          format: uuid
          description: Stable identifier.
        ingested:
          type: integer
          format: int64
          description: Raw results normalised into a contact (`status = 'ingested'`).
        limit:
          type: integer
          format: int32
          description: Requested place cap.
          minimum: 0
        niche:
          type: string
          description: Niche / vertical query.
        status:
          type: string
          description: Lifecycle status.
  securitySchemes:
    api_key:
      type: http
      scheme: bearer
    session:
      type: apiKey
      in: cookie
      name: asap_session