> ## 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 a specific integration type

> Get detailed information about a specific integration type by its name. Returns the integration type's categories, display name, description, and configuration schemas.



## OpenAPI

````yaml /openapi.json get /integration/type/{name}/
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:
  /integration/type/{name}/:
    get:
      tags:
        - integration-types
      summary: Get a specific integration type
      description: >-
        Get detailed information about a specific integration type by its name.
        Returns the integration type's categories, display name, description,
        and configuration schemas.
      operationId: get_integration_type
      parameters:
        - in: path
          name: name
          required: true
          schema:
            maxLength: 255
            minLength: 1
            title: Name
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationTypeRead'
          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: Integration type not found
        '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:
    IntegrationTypeRead:
      description: Integration type metadata for the directory listing.
      properties:
        categories:
          description: e.g. ['CRM', 'Marketing Automation']
          items:
            type: string
          title: Categories
          type: array
        company_domain:
          description: e.g. 'google.com', 'intercom.com'
          title: Company Domain
          type: string
        config_schema:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          description: OpenAPI schema for connection settings. None if not implemented.
          title: Config Schema
        connect_methods:
          description: >-
            The ways a user can connect this integration. Contains
            'oauth_connect' when an app-listing OAuth manifest exists, and
            'credentials_form' when the SDK exposes a non-empty (API-key)
            credentials form. A single-method type returns exactly one entry
            (the UI renders as before); a type supporting both returns both (the
            UI shows a chooser). Empty for unimplemented types.
          items:
            $ref: '#/components/schemas/IntegrationConnectMethod'
          title: Connect Methods
          type: array
        created_at:
          description: When added to directory
          format: date-time
          title: Created At
          type: string
        credentials_schema:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          description: OpenAPI schema for auth credentials. None if not implemented.
          title: Credentials Schema
        description:
          description: What the integration does, shown in detail view
          title: Description
          type: string
        display_name:
          description: UI label. e.g. 'Google Sheets'
          title: Display Name
          type: string
        icon_url:
          description: Full URL to icon. e.g. 'https://static.../intercom.svg'
          title: Icon Url
          type: string
        id:
          description: Unique ID. e.g. '123e4567-e89b-12d3-a456-426614174000'
          format: uuid
          title: Id
          type: string
        implemented:
          description: False = coming soon, can't connect yet
          title: Implemented
          type: boolean
        integration_type:
          description: Unique ID. e.g. 'googlesheets', 'intercom'
          title: Integration Type
          type: string
        is_marketplace_listing:
          default: false
          description: >-
            True when this integration has a marketplace app-listing
            (OAuth-connect or credentials-form). Orthogonal to connect_method:
            the directory renders a 'Connect <X>' button for a marketplace
            listing even when connect_method is 'credentials_form'. Derived from
            the app-listings catalog.
          title: Is Marketplace Listing
          type: boolean
        kind:
          $ref: '#/components/schemas/IntegrationKindFilter'
          default: both
          description: '''source'', ''destination'', or ''both'''
        name:
          description: Sort key. e.g. 'Google Sheets', 'Intercom'
          title: Name
          type: string
        overview:
          description: Brief overview of the integration's sync capabilities
          title: Overview
          type: string
        record_types:
          description: >-
            Record types this integration syncs, as display-ready chips. Empty
            for 'coming soon' integrations. Wildcard integrations include a
            'Custom' marker.
          items:
            $ref: '#/components/schemas/IntegrationRecordTypeReadSchema'
          title: Record Types
          type: array
        tagline:
          description: Short tagline naming key data objects synced
          title: Tagline
          type: string
        updated_at:
          description: Last metadata update
          format: date-time
          title: Updated At
          type: string
      required:
        - id
        - name
        - integration_type
        - display_name
        - company_domain
        - categories
        - description
        - tagline
        - overview
        - icon_url
        - implemented
        - config_schema
        - credentials_schema
        - created_at
        - updated_at
      title: IntegrationTypeRead
      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
    IntegrationConnectMethod:
      description: >-
        How a user connects an integration in the UI.


        Extensible: as app listings gain non-OAuth connect flows (e.g.
        install-bound URL secret,

        per-install signature), add members here rather than another boolean.


        An integration *type* can advertise more than one of these (see

        ``IntegrationTypeRead.connect_methods``); a specific *connection*
        records the single method it

        was created with on ``IntegrationModel.connect_method``.
      enum:
        - oauth_connect
        - credentials_form
      title: IntegrationConnectMethod
      type: string
    IntegrationKindFilter:
      description: 'Query filter: source-only, destination-only, or both.'
      enum:
        - source
        - destination
        - both
      title: IntegrationKindFilter
      type: string
    IntegrationRecordTypeReadSchema:
      description: >-
        A record type an integration handles, with a display-ready name.


        Shared by the integrations list, the directory, and the record-type
        vocabulary endpoint so

        record-type chips render the same way everywhere.
      properties:
        display_name:
          description: Human-readable name (e.g. 'Person', 'Contacts', 'Custom').
          title: Display Name
          type: string
        is_custom:
          description: >-
            True for the wildcard 'Custom' marker (arbitrary/dynamic record
            types).
          title: Is Custom
          type: boolean
        slug:
          description: The record-type slug (e.g. 'person', 'contacts'), or '*' for Custom.
          title: Slug
          type: string
      required:
        - slug
        - display_name
        - is_custom
      title: IntegrationRecordTypeReadSchema
      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
  securitySchemes:
    HTTPBearer:
      scheme: bearer
      type: http
    APIKeyHeader:
      in: header
      name: X-API-Key
      type: apiKey

````