> ## 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.

# Get an account's overview

> Read what an account's page shows above its tabs: each fact about the company (industry, size, location and the like), as the cell a rep pinned or else the newest value the company rows hold, with the table and column it came from, how many other cells agree and every other value the rows give; and a card for every table holding rows on it. Free.



## OpenAPI

````yaml /openapi.json get /accounts/{account_key}/overview/
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: >-
      The docked AI Assistant: its general chat about the workspace and the
      product, streamed as Server-Sent Events, and the one list of a person's
      threads across every assistant, with pin, rename, delete and the
      search-to-table link.
    name: assistant
  - description: >-
      The messages a person keeps to send the assistant again: the ones the
      workspace saved and the ones that ship with the product, with save,
      rename, edit and delete.
    name: assistant-prompt
  - description: >-
      Granted workspace actions: what the AI Assistant proposed or applied in a
      conversation, the approve and dismiss decisions on each card, the
      workspace's spend threshold and default grants, and the eight verbs.
    name: workspace-actions
  - description: >-
      The Getting started checklist: a workspace's progress through the six
      steps from its first people search to its first launched sequence.
    name: onboarding
  - description: Senders, connected mailboxes, tags, and the Google connect flow.
    name: senders
  - description: The workspace do-not-contact list, enforced before every send.
    name: suppression
  - description: >-
      The workspace's recontact rule: how long before anyone hears from us
      again.
    name: contact_cooldown
  - description: 'Sequence authoring: the graph, the table-backed audience, previews.'
    name: sequences
  - description: >-
      The outbound agent behind a sequence: the voice it writes in, its
      per-message prompts, what it wrote and what people told it.
    name: outbound-agents
  - 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 approval queue: everything waiting on a person across every sender and
      channel, and the workspace's manual or automatic modes per channel.
    name: outreach
  - 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 listing, checking and deleting integrations.
    name: integrations
  - description: >-
      Create, preview and update an integration of any type: the body's
      integration_type picks the config and credentials it takes.
    name: integration-specific
  - 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: >-
      AI apps connected to the workspace: Claude, ChatGPT, Claude Code or any
      other MCP client a person signed in to Oneprofile's MCP server with.
    name: ai_apps
  - description: Endpoints for managing billing and subscription information.
    name: billing
  - description: >-
      Accounts: every company the workspace's tables name, with the people at
      it, its key facts, its tables, its org chart and what went to its people;
      the tables that feed it (Sources) and the merges a person made.
    name: accounts
  - 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 an agent's Preview: example rows run one at a time, and a
      Looks good on each. Needs work lives under agent-learnings.
    name: agent-training
  - description: >-
      An agent's learnings, the one-line rules it follows on every output, and
      the thumbs down that teaches them: give one with what was wrong, list the
      ones on a subject, Undo one, and price the redo it would run.
    name: agent-learnings
  - 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: >-
      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. Alongside people
      and company searches, leads can be sourced from buying signals (what a
      company or person just did), with a catalogue endpoint behind the picker
      that builds them.
    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 affiliate program's own dashboard: enrolling and
      claiming a code, the summary, stats and activity feed, the commission
      ledger, and identity verification and payouts.
    name: affiliate
  - description: >-
      Endpoints for recording where a new workspace came from: the marketing
      page or campaign its signup link carried, sent once after signup.
    name: attribution
  - 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, interest signals and social
      proof), plus domain-based generation and the reference documents whose
      summaries ride alongside those fields.
    name: ai-context
  - description: >-
      Endpoints for the signed-in user's Google Drive connection: starting and
      finishing the OAuth grant, checking or dropping it, and minting the
      short-lived token the Google Picker needs.
    name: google-drive
paths:
  /accounts/{account_key}/overview/:
    get:
      tags:
        - accounts
      summary: Get an account's overview
      description: >-
        Read what an account's page shows above its tabs: each fact about the
        company (industry, size, location and the like), as the cell a rep
        pinned or else the newest value the company rows hold, with the table
        and column it came from, how many other cells agree and every other
        value the rows give; and a card for every table holding rows on it.
        Free.
      operationId: get_account_overview
      parameters:
        - in: path
          name: account_key
          required: true
          schema:
            $ref: '#/components/schemas/AccountKeyPath'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountOverviewSchema'
          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
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
          description: No account by that key in this workspace.
        '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:
        - APIKeyHeader: []
        - HTTPBearer: []
components:
  schemas:
    AccountKeyPath:
      description: >-
        The account's key: its domain (acme.com), or its LinkedIn page
        (li-co:acme).
      maxLength: 320
      minLength: 1
      pattern: ^(?:[^/.][^/]*|\.[^/.][^/]*|\.\.[^/]+)$
      type: string
    AccountOverviewSchema:
      description: >-
        What an account's page shows above its tabs: the facts, and every table
        it is in.
      properties:
        facts:
          items:
            $ref: '#/components/schemas/AccountFactReadSchema'
          title: Facts
          type: array
        merged_keys:
          description: The accounts a person merged into this one.
          items:
            type: string
          title: Merged Keys
          type: array
        merges:
          description: >-
            Each merge into this account: the account merged in, who merged it
            and when.
          items:
            $ref: '#/components/schemas/AccountMergeReadSchema'
          title: Merges
          type: array
        tables:
          items:
            $ref: '#/components/schemas/AccountTableCardReadSchema'
          title: Tables
          type: array
      required:
        - facts
        - tables
        - merged_keys
        - merges
      title: AccountOverviewSchema
      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
    NotFoundResponse:
      properties:
        detail:
          description: The detail of why the resource was not found.
          title: Detail
          type: string
      required:
        - detail
      title: NotFoundResponse
      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
    AccountFactReadSchema:
      description: >-
        One fact about the company: the value shown, the cell it is in, and what
        else the rows say.


        The value shown is the cell a rep pinned, else the newest value of the

        account's own company rows, else of a company merged in.
      properties:
        agreeing:
          description: Other rows giving the same value, however each spells it.
          title: Agreeing
          type: integer
        column_id:
          format: uuid
          title: Column Id
          type: string
        column_name:
          title: Column Name
          type: string
        disagreeing:
          description: Each other value the rows give, newest first, at most five.
          items:
            $ref: '#/components/schemas/AccountFactValueReadSchema'
          title: Disagreeing
          type: array
        disagreeing_count:
          description: >-
            How many other values the rows give; ``disagreeing`` lists the
            newest five.
          title: Disagreeing Count
          type: integer
        display_value:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The value as the page prints it, when not as the cell holds it: a
            website's host, a headcount or revenue held as bare digits in full.
          title: Display Value
        kind:
          $ref: '#/components/schemas/AccountFactKind'
        pin_lost:
          description: >-
            A rep pinned a cell that holds no value here any more, so the newest
            row decides.
          title: Pin Lost
          type: boolean
        pinned_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Pinned At
        pinned_by_user_id:
          anyOf:
            - type: string
            - type: 'null'
          description: Who pinned the fact to a cell; null when the newest row decides.
          title: Pinned By User Id
        record_id:
          format: uuid
          title: Record Id
          type: string
        table_id:
          format: uuid
          title: Table Id
          type: string
        table_name:
          title: Table Name
          type: string
        updated_at:
          format: date-time
          title: Updated At
          type: string
        value:
          title: Value
          type: string
      required:
        - kind
        - value
        - table_id
        - table_name
        - column_id
        - column_name
        - record_id
        - updated_at
        - agreeing
        - disagreeing_count
        - disagreeing
        - pinned_by_user_id
        - pinned_at
        - pin_lost
      title: AccountFactReadSchema
      type: object
    AccountMergeReadSchema:
      description: >-
        One merge a person made: every row of the first account shows on the
        second.
      properties:
        created_at:
          format: date-time
          title: Created At
          type: string
        created_by_user_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Created By User Id
        from_key:
          title: From Key
          type: string
        to_key:
          title: To Key
          type: string
      required:
        - from_key
        - to_key
        - created_by_user_id
        - created_at
      title: AccountMergeReadSchema
      type: object
    AccountTableCardReadSchema:
      description: 'One linked table''s rows on the account: how many, and the newest few.'
      properties:
        row_count:
          description: Its rows on the account; its people, for a people table.
          title: Row Count
          type: integer
        row_kind:
          $ref: '#/components/schemas/AccountRowKind'
        rows:
          description: >-
            The newest few rows; on a people table, one row a person, the most
            senior first.
          items:
            $ref: '#/components/schemas/AccountTableRowReadSchema'
          title: Rows
          type: array
        table_id:
          format: uuid
          title: Table Id
          type: string
        table_name:
          title: Table Name
          type: string
        tool_name:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The tool the table is imported from, when that tool links its
            records.
          title: Tool Name
      required:
        - table_id
        - table_name
        - row_kind
        - row_count
        - rows
      title: AccountTableCardReadSchema
      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
    AccountFactValueReadSchema:
      description: >-
        One value the rows give a fact other than the one shown, at its newest
        cell.
      properties:
        column_id:
          format: uuid
          title: Column Id
          type: string
        column_name:
          title: Column Name
          type: string
        display_value:
          anyOf:
            - type: string
            - type: 'null'
          description: The value as the page prints it, when not as the cell holds it.
          title: Display Value
        record_id:
          format: uuid
          title: Record Id
          type: string
        rows:
          description: How many cells give this value, however each spells it.
          title: Rows
          type: integer
        table_id:
          format: uuid
          title: Table Id
          type: string
        table_name:
          title: Table Name
          type: string
        updated_at:
          format: date-time
          title: Updated At
          type: string
        value:
          title: Value
          type: string
      required:
        - value
        - table_id
        - table_name
        - column_id
        - column_name
        - record_id
        - updated_at
        - rows
      title: AccountFactValueReadSchema
      type: object
    AccountFactKind:
      description: >-
        A fact the account page shows about the company, read from its company
        rows.
      enum:
        - name
        - website
        - company_page
        - industry
        - employees
        - location
        - country
        - description
        - founded
        - revenue
      title: AccountFactKind
      type: string
    AccountRowKind:
      description: >-
        What one row of a linked table stands for on an account: the company, or
        a person there.
      enum:
        - company
        - person
      title: AccountRowKind
      type: string
    AccountTableRowReadSchema:
      properties:
        cells:
          items:
            $ref: '#/components/schemas/AccountCellReadSchema'
          title: Cells
          type: array
        label:
          anyOf:
            - type: string
            - type: 'null'
          title: Label
        record_id:
          format: uuid
          title: Record Id
          type: string
        url:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The row's record in the tool its table is imported from, when it
            links one.
          title: Url
      required:
        - record_id
        - label
        - cells
      title: AccountTableRowReadSchema
      type: object
    AccountCellReadSchema:
      properties:
        column_id:
          format: uuid
          title: Column Id
          type: string
        column_name:
          title: Column Name
          type: string
        value:
          anyOf:
            - type: string
            - type: 'null'
          title: Value
      required:
        - column_id
        - column_name
        - value
      title: AccountCellReadSchema
      type: object
  securitySchemes:
    APIKeyHeader:
      in: header
      name: X-API-Key
      type: apiKey
    HTTPBearer:
      scheme: bearer
      type: http

````

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