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

# List enrichment actions

> The server-owned catalog of enrichment actions the picker renders. Sorted by category then display name; development-only actions are absent in production.



## OpenAPI

````yaml /openapi.json get /table-enrichments/actions/
openapi: 3.1.0
info:
  contact:
    email: support@getoneprofile.ai
    name: Oneprofile Support
  description: >-
    REST API reference for Oneprofile, the GTM data layer for your CRM. Manage
    tables, enrichments, and integrations. Authenticate with an API key to get
    started.
  termsOfService: https://www.getoneprofile.ai/terms
  title: API Reference | Oneprofile
  version: '0.0'
servers:
  - url: https://api.getoneprofile.ai
security: []
tags:
  - description: Sender profiles, connected mailboxes, tags, and the Google connect flow.
    name: senders
  - description: The workspace do-not-contact list, enforced before every send.
    name: suppression
  - description: 'Sequence authoring: the graph, the table-backed audience, previews.'
    name: sequences
  - description: >-
      The LinkedIn channel: connecting an account to a sender, its safety limits
      and history, and the protocol the browser extension speaks.
    name: linkedin
  - description: 'The unified outreach inbox: threads, replies, labels, events.'
    name: inbox
  - description: 'The AI reply layer: workspace settings, drafts, and approval.'
    name: inbox-ai
  - description: Notification rules, per-user preferences, and the Slack connection.
    name: notifications
  - description: Endpoints for seeing all available integration types.
    name: integration-types
  - description: Endpoints for creating and managing integrations.
    name: integrations
  - description: Endpoints for the generic OAuth install/claim app-listings engine.
    name: app-listings
  - description: Endpoints for creating and managing API keys.
    name: apikey
  - description: Endpoints for managing billing and subscription information.
    name: billing
  - description: Endpoints for creating and managing tables.
    name: tables
  - description: Endpoints for table columns, formula previews, and on-demand column runs.
    name: table-columns
  - description: Endpoints for table rows and manual cell edits.
    name: table-rows
  - description: Endpoints for observing and cancelling table recompute runs.
    name: table-runs
  - description: >-
      Endpoints for org-shared per-column display preferences: hidden, pinned,
      width, and colour tint.
    name: table-ui-prefs
  - description: >-
      Endpoints for the org-shared names given to the column tint palette: what
      this organisation calls each colour. Org-level, not per-table.
    name: table-column-color-labels
  - description: >-
      Endpoints for the enrichment action catalog, model list, presets, draft
      generation, and saved agents.
    name: table-enrichments
  - description: >-
      Endpoints for teaching a saved agent from example rows: training sessions,
      per-row feedback, and the proposed prompt to approve.
    name: agent-training
  - description: >-
      The durable audit trail of a table's enrichment actions: configured,
      edited, run, cancelled, and settled cost.
    name: table-enrichment-audit-logs
  - description: Endpoints for saving and applying column templates.
    name: table-templates
  - description: Server-sent change feed for a table's grid.
    name: table-events
  - description: 'Endpoints for org-shared saved table views: sort, filters, hidden columns.'
    name: table-views
  - description: >-
      The per-table AI Assistant: named conversations, the column suggestions a
      build turn produces, and the questions an analyze turn answers.
    name: table-assistant
  - description: >-
      Endpoints for PER-USER table preferences: favourites and recently opened.
      Unlike the rest of the table surface these are personal, so two members of
      one organisation legitimately see different answers.
    name: table-user-prefs
  - description: >-
      Endpoints for building a table from an uploaded CSV: upload and preview
      the inferred columns, commit the reviewed mapping, then poll the row load.
    name: table-imports
  - description: Endpoint for downloading a table's rows as CSV.
    name: table-export
  - description: >-
      Endpoints for the integration a table imports from: attach and preview it,
      promote imported fields into columns, and run the import on demand.
    name: table-sources
  - description: >-
      Endpoints for a table's recurring import cadence: set it, pause it, and
      read the next fire times.
    name: table-schedules
  - description: >-
      Endpoints for pushing a table's rows out to a connected integration: list
      writable destinations, derive their write capabilities, and map export
      columns.
    name: table-writeback
  - description: >-
      Endpoints backing a lookup column's setup: the connections whose records a
      column could read, and the identity fields one record type can be looked
      up by.
    name: table-integration-lookup
  - description: >-
      Endpoints for sourcing leads from the lead database: count and preview
      matches, land them in a table, and keep saved searches.
    name: find-leads
  - description: >-
      Endpoints for discovering a domain's subdomains from public certificate
      logs and landing the results in a table.
    name: find-subdomains
  - description: Endpoints for the credit balance meter and usage reporting.
    name: credits
  - description: >-
      Endpoints for the workspace referral program: the shareable link, the
      friends who joined through it, and claiming a code after signup.
    name: referral
  - description: >-
      Endpoints for the design partner program's customer surface: whether this
      workspace is a design partner, the badges its feedback has earned, and
      sending and reading that feedback.
    name: design-partner
  - description: >-
      Endpoints for the org-level AI business context — company description,
      ideal customer profile, buyer personas and interest signals — plus
      domain-based generation.
    name: ai-context
paths:
  /table-enrichments/actions/:
    get:
      tags:
        - table-enrichments
      summary: List enrichment actions
      description: >-
        The server-owned catalog of enrichment actions the picker renders.
        Sorted by category then display name; development-only actions are
        absent in production.
      operationId: list_enrichment_actions
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnrichmentActionCatalogResponseSchema'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenResponse'
          description: Forbidden
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityResponse'
          description: Invalid request made to the API.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Internal server error.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Bad gateway error.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Service unavailable.
      security:
        - HTTPBearer: []
        - APIKeyHeader: []
components:
  schemas:
    EnrichmentActionCatalogResponseSchema:
      description: The enrichment actions available in this environment, in display order.
      properties:
        actions:
          items:
            $ref: '#/components/schemas/EnrichmentActionSchema'
          title: Actions
          type: array
      required:
        - actions
      title: EnrichmentActionCatalogResponseSchema
      type: object
    UnauthorizedResponse:
      properties:
        detail:
          description: The detail of why the request is unauthorized.
          title: Detail
          type: string
      required:
        - detail
      title: UnauthorizedResponse
      type: object
    ForbiddenResponse:
      properties:
        detail:
          description: The detail of why the request is forbidden.
          title: Detail
          type: string
      required:
        - detail
      title: ForbiddenResponse
      type: object
    UnprocessableEntityResponse:
      properties:
        detail:
          description: >-
            The detail of the error. This is the error message to show to the
            user. You should also use the issues field to show more detailed
            error messages per field. Use this field for a single liner error
            message.
          title: Detail
          type: string
        issues:
          description: >-
            The issues that caused the error. There can be multiple issues. Each
            issue is a user-facing error message.
          items:
            $ref: '#/components/schemas/UnprocessableEntityIssue'
          title: Issues
          type: array
      required:
        - detail
        - issues
      title: UnprocessableEntityResponse
      type: object
    ServerErrorResponse:
      properties:
        detail:
          description: The detail of why the server returned an error.
          title: Detail
          type: string
      required:
        - detail
      title: ServerErrorResponse
      type: object
    EnrichmentActionSchema:
      description: One enrichment action as the picker renders it.
      properties:
        category:
          $ref: '#/components/schemas/EnrichmentActionCategory'
          description: The picker section this action sits under.
        column_name:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The noun a new column made from this action takes as its header.
            Separate from `display_name`, which sells the action in the picker
            and reads as a job ('Find a person's LinkedIn profile'), while a
            header names what the cells hold ('LinkedIn profile'). Null means
            the action never needed the distinction — a single-output action IS
            its output, so the frontend takes that output's name.
          title: Column Name
        credits_per_row:
          anyOf:
            - type: number
            - type: 'null'
          description: >-
            The action's own flat per-successful-row price in decimal credits,
            when it prices per action rather than per model. Surfaces as the 'N
            / row' cost label on catalog rows and in the editor; null means the
            price derives from the selected model.
          title: Credits Per Row
        description:
          description: 'One line: what the action does.'
          title: Description
          type: string
        display_name:
          title: Display Name
          type: string
        family:
          anyOf:
            - $ref: '#/components/schemas/EnrichmentFamily'
            - type: 'null'
          description: >-
            The outcome shelf this action sits on WITHIN its category's tab —
            the second level under `category`, which picks the tab itself. Set
            on the data enrichments, whose tab is one long list authored by
            input ('Enrich person from email', '...from LinkedIn') and read by
            outcome; null on everything else, and on a stored waterfall filed
            under a value this deployment no longer knows.
        icon:
          description: An icon token the frontend maps to an asset.
          title: Icon
          type: string
        input_contract:
          description: >-
            The settings kind this action accepts — what an action_settings
            payload must declare to configure it. Also how the editor knows the
            shape of the configuration: 'enrichment' binds every declared input
            to a column, 'column' binds exactly one and has no prompt at all,
            and everything else is prompt-driven.
          title: Input Contract
          type: string
        inputs:
          description: >-
            The facts this action needs supplied, each bound to a column. Empty
            for the prompt-driven actions. Several sources are checked behind
            one data enrichment and they need different facts, so binding a
            subset is normal there — it narrows which can run, it does not break
            the column. A 'column'-contract action declares exactly one, and it
            is the whole configuration.
          items:
            $ref: '#/components/schemas/EnrichmentCanonicalFieldSchema'
          title: Inputs
          type: array
        key:
          description: The registry key stored on enrichment column definitions.
          title: Key
          type: string
        output_contract:
          description: >-
            What the action produces: 'text' (one free-form value), 'structured'
            (obeys the column's declared output schema) or 'object' (a fixed
            object whose fields are this action's declared `outputs` — nothing
            for a column to declare, so no output builder). Consumers branch on
            THIS, never on the key.
          title: Output Contract
          type: string
        outputs:
          description: >-
            The facts this action can return. A data enrichment's output builder
            seeds from these; for an 'object'-contract action they ARE the
            output, fixed, and there is nothing to build.
          items:
            $ref: '#/components/schemas/EnrichmentCanonicalFieldSchema'
          title: Outputs
          type: array
        pricing_key:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The credit price-catalog key this action charges against; null is
            free.
          title: Pricing Key
        provider_key:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Who fulfils this action — the external service its calls go to; null
            means it runs entirely inside the product. The catalog attributes
            every capability to its provider, so this is what the Tools panel
            puts on the row and groups a provider's page by.
          title: Provider Key
        provider_operation:
          anyOf:
            - $ref: '#/components/schemas/EnrichmentProviderOperationSchema'
            - type: 'null'
          description: >-
            For provider-category actions only: which integration operation this
            action fronts, with its typed inputs and outputs. The editor renders
            input bindings and default output fields from this — there is no
            per-provider frontend.
        refund_rules:
          description: >-
            The action's declared refund promises: 'success_no_data' (an
            empty-handed success is free), 'success_blocked_data'
            (compliance-withheld data is free), 'success_preview_run' (previews
            are charged then refunded). The editor prints these so the promise
            is visible before running.
          items:
            $ref: '#/components/schemas/EnrichmentRefundRule'
          title: Refund Rules
          type: array
        settings_fields:
          description: >-
            The action's own configuration, field by field. One generic editor
            renders these, so an action with settings never waits for a frontend
            of its own.
          items:
            $ref: '#/components/schemas/EnrichmentActionSettingFieldSchema'
          title: Settings Fields
          type: array
        tagline:
          description: >-
            A few words for the picker's meta line; empty falls back to the
            category word.
          title: Tagline
          type: string
      required:
        - key
        - display_name
        - category
        - description
        - tagline
        - icon
        - pricing_key
        - input_contract
        - output_contract
        - provider_key
      title: EnrichmentActionSchema
      type: object
    UnprocessableEntityIssue:
      properties:
        input:
          anyOf:
            - type: string
            - type: integer
            - type: number
            - type: boolean
            - items: {}
              type: array
            - additionalProperties: true
              type: object
          description: The user's input that caused the error.
          title: Input
        loc:
          description: >-
            The location of the error. Always contains 1 or 2 elements. The
            first element is the type of location (e.g. 'body', 'query', 'path',
            'header'). The second element is the name of the field that caused
            the error. If the error is not related to a specific field, the
            second element is not present.
          items:
            type: string
          title: Loc
          type: array
        msg:
          description: The message of the error. The error message to show to the user.
          title: Msg
          type: string
        type:
          description: >-
            The type of the error. Useful for frontend code to handle different
            types of errors.
          title: Type
          type: string
      required:
        - loc
        - msg
        - type
        - input
      title: UnprocessableEntityIssue
      type: object
    EnrichmentActionCategory:
      description: >-
        The section an enrichment action sits under in the picker.


        Ordered as the picker shows them. ``DEVELOPMENT`` exists so the dev-only

        test actions render under their own clearly-labelled heading and can
        never

        be mistaken for a product feature.
      enum:
        - ai
        - web
        - workspace
        - enrichment
        - development
      title: EnrichmentActionCategory
      type: string
    EnrichmentFamily:
      description: >-
        The OUTCOME shelf one data enrichment sits on inside the Enrichment tab.


        A second axis under :class:`EnrichmentActionCategory`, not a replacement
        for

        it: the category answers "what kind of bargain is this" (a vendor

        waterfall, a prompt, a free function) and picks the TAB; the family
        answers

        "what do I get out of it" and picks the SHELF within that tab.


        It exists because the catalog is authored by INPUT — five ways to enrich
        a

        person differing only in the key you hand them, three ways to enrich a

        company, two ways to find a LinkedIn URL — while people browse it by

        OUTCOME. A flat list of sixteen makes the reader derive the grouping

        themselves from sixteen verb phrases, every time they open the tab.


        Ordered as the shelves render. Authored per waterfall in

        ``enrichment_catalog.yaml`` beside ``icon`` and ``tagline``, so a new

        waterfall declares its shelf in the same edit that creates it rather
        than

        landing in whichever bucket a frontend map happens to guess.
      enum:
        - email
        - phone
        - company
        - person
        - social
        - relationships
      title: EnrichmentFamily
      type: string
    EnrichmentCanonicalFieldSchema:
      description: One fact a data enrichment takes in or gives back.
      properties:
        always_present:
          default: true
          description: >-
            Outputs only: whether a successful row always carries this fact.
            False marks a fact that can come back empty even when the enrichment
            worked, so the editor can say so while the column is being set up
            rather than leaving it to be discovered.
          title: Always Present
          type: boolean
        auto_promote:
          default: true
          description: >-
            Outputs only: whether the fan-out gives this fact a column of its
            own. False keeps it payload-only — stored with the answer and
            promotable by hand — for provenance-grade facts that would otherwise
            widen every table they land on.
          title: Auto Promote
          type: boolean
        choices:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          description: >-
            Select outputs only: the fixed vocabulary the answer comes from, so
            a column created from this fact is born with its options set.
          title: Choices
        creates_column:
          default: true
          description: >-
            Outputs only: whether setting this action up actually adds a column
            for this fact. Derived — it is auto_promote AND a type the fan-out
            can expand (a list or nested object has no single cell shape and
            stays in the payload). Sent already resolved so the column editor's
            outputs preview can promise exactly the columns that will appear,
            rather than restating two rules and drifting.
          title: Creates Column
          type: boolean
        description:
          title: Description
          type: string
        display_name:
          title: Display Name
          type: string
        field_type:
          $ref: '#/components/schemas/TableColumnType'
          description: The column type this fact stores as.
        name:
          description: The key a column's bindings and output fields use.
          title: Name
          type: string
        required:
          default: false
          description: >-
            Inputs only: whether the enrichment cannot run without it. False
            where several facts can each drive it.
          title: Required
          type: boolean
      required:
        - name
        - display_name
        - description
        - field_type
      title: EnrichmentCanonicalFieldSchema
      type: object
    EnrichmentProviderOperationSchema:
      description: The provider-side identity of an integration-backed enrichment action.
      properties:
        inputs:
          items:
            $ref: '#/components/schemas/EnrichmentProviderFieldSchema'
          title: Inputs
          type: array
        integration_type:
          description: The integration slug — also the connect-flow integration type.
          title: Integration Type
          type: string
        operation_key:
          description: The operation's stable key within the SDK.
          title: Operation Key
          type: string
        outputs:
          items:
            $ref: '#/components/schemas/EnrichmentProviderFieldSchema'
          title: Outputs
          type: array
        required_input_combinations:
          description: >-
            Alternative input sets that each make the operation runnable — a
            configuration saves when ANY one set is fully bound. The editor
            renders this as 'needs A + B, or C'.
          items:
            items:
              type: string
            type: array
          title: Required Input Combinations
          type: array
      required:
        - integration_type
        - operation_key
        - inputs
        - outputs
      title: EnrichmentProviderOperationSchema
      type: object
    EnrichmentRefundRule:
      description: >-
        A declarative promise about when a charged cell's credits come back.


        Declared per action so "you won't be charged when nothing is found" is a

        catalog fact the UI can print and a test can enforce — not folklore
        about

        how the charge code happens to behave.
      enum:
        - success_no_data
        - success_blocked_data
        - success_preview_run
      title: EnrichmentRefundRule
      type: string
    EnrichmentActionSettingFieldSchema:
      description: One configurable setting of an action, as the editor renders it.
      properties:
        default:
          anyOf:
            - type: string
            - type: integer
            - type: number
            - type: boolean
            - type: 'null'
          title: Default
        description:
          title: Description
          type: string
        display_name:
          title: Display Name
          type: string
        kind:
          description: >-
            How to draw the control: 'text', 'textarea', 'number', 'boolean',
            'select', 'key_value' (string map) or 'column' (a picker over this
            table's columns).
          title: Kind
          type: string
        name:
          description: The payload key this field writes.
          title: Name
          type: string
        options:
          description: Allowed values for a 'select' field.
          items:
            type: string
          title: Options
          type: array
        required:
          default: false
          title: Required
          type: boolean
        secret:
          default: false
          description: Render masked.
          title: Secret
          type: boolean
      required:
        - name
        - display_name
        - description
        - kind
      title: EnrichmentActionSettingFieldSchema
      type: object
    TableColumnType:
      description: >-
        The type a user picks for a table column.


        Ordered as the picker shows them, which is also the order the groups
        below

        run in: text-ish, then numeric, then choice, then structured.
      enum:
        - text
        - paragraph
        - url
        - email
        - image_url
        - person
        - select
        - number
        - decimal
        - currency
        - checkbox
        - date
        - multi_select
        - list
        - object
      title: TableColumnType
      type: string
    EnrichmentProviderFieldSchema:
      description: One declared input or output field of a provider enrichment operation.
      properties:
        description:
          title: Description
          type: string
        display_name:
          title: Display Name
          type: string
        example:
          anyOf:
            - type: string
            - type: integer
            - type: number
            - type: boolean
            - type: 'null'
          description: A sample value shown before anything has run.
          title: Example
        name:
          description: The stable field name used in bindings and payloads.
          title: Name
          type: string
        required:
          description: 'Inputs only: the operation cannot run without this field.'
          title: Required
          type: boolean
        value_kind:
          description: >-
            JSON-schema primitive kind ('string', 'integer', 'number',
            'boolean', 'array', 'object') — a rendering hint.
          title: Value Kind
          type: string
      required:
        - name
        - display_name
        - description
        - required
        - value_kind
      title: EnrichmentProviderFieldSchema
      type: object
  securitySchemes:
    HTTPBearer:
      scheme: bearer
      type: http
    APIKeyHeader:
      in: header
      name: X-API-Key
      type: apiKey

````