> ## 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 integration > Get an integration by its ID. ## OpenAPI ````yaml /openapi.json get /integration/{integration_id}/ 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/{integration_id}/: get: tags: - integrations summary: Get an integration description: Get an integration by its ID. operationId: get_integration parameters: - in: path name: integration_id required: true schema: format: uuid title: Integration Id type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/IntegrationRead' 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 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: IntegrationRead: description: >- Response model for List Integrations endpoint. This model specifically does not include the config field. Use the integration specific read model whenever possible. properties: connect_method: $ref: '#/components/schemas/IntegrationConnectMethod' default: credentials_form description: >- How this connection authenticates: 'credentials_form' (API-key form) or 'oauth_connect' (one-click app-listing OAuth). Gates the switch/reconnect surfaces in the UI. created_at: format: date-time title: Created At type: string created_by_actor_type: $ref: '#/components/schemas/CreatedByActorType' description: >- Type of actor that created this integration: 'user', 'api', or 'system'. created_by_display_name: anyOf: - type: string - type: 'null' description: Display name of the creator. User's full name or 'API - {key name}'. title: Created By Display Name health_checked_at: anyOf: - format: date-time type: string - type: 'null' description: When the latest health check was performed. title: Health Checked At health_error_code: anyOf: - type: string - type: 'null' description: >- Machine-readable error code from the latest health check (e.g. 'unauthorized', 'insufficient_permissions', 'rate_limited'). Drives the 'Action required — reauthorize' state and Reconnect CTA when it is 'unauthorized' or 'insufficient_permissions'. Null if never checked or healthy. title: Health Error Code health_error_message: anyOf: - type: string - type: 'null' description: Error message from the latest health check, if unhealthy. title: Health Error Message health_status: anyOf: - $ref: '#/components/schemas/IntegrationHealthStatus' - type: 'null' description: >- Latest health check status: healthy, warning, or error. Null if never checked. id: format: uuid title: Id type: string integration_type: description: The type of the integration. title: Integration Type type: string kind: $ref: '#/components/schemas/IntegrationKindFilter' description: Indicates if the integration is a source, destination, or both. name: description: The name of the integration as defined by the user. title: Name type: string org_id: title: Org Id type: string record_types: description: >- Record types this integration supports, as display-ready chips matching the Data tab. Wildcard integrations also include a 'Custom' marker. items: $ref: '#/components/schemas/IntegrationRecordTypeReadSchema' title: Record Types type: array updated_at: format: date-time title: Updated At type: string required: - id - org_id - integration_type - name - kind - created_at - updated_at - created_by_actor_type title: IntegrationRead 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 CreatedByActorType: description: >- Type of actor that created an integration. Defined here rather than in ``sql_models`` so callers have a legal import path: this enum appears in the package's public signatures, and repository and model modules are private to the package. enum: - user - api - system title: CreatedByActorType type: string IntegrationHealthStatus: enum: - healthy - warning - error title: IntegrationHealthStatus 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 ````