---
title: "Connect Integration"
method: POST
path: "/v1/integrations/{integration_id}/connect"
tags: ["integrations"]
---

# Connect Integration

`POST /v1/integrations/{integration_id}/connect`

## Request

- Base URL: `https://api.mentium.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.mentium.io/v1/integrations/{integration_id}/connect`
- Auth: HTTP bearer

## Path parameters

- `integration_id` string, uuid, required

## Headers

- `mentium-workspace-id` string, nullable

## Request body

- IntegrationConnectionInput
  - `keys` KeyInfo[]
    - `key` string, required
    - `value` string, required
    - `is_secret` boolean, required
  - `scope` 'ORGANIZATION' | 'WORKSPACE' | 'USER'
  - `name` string, nullable
  - `redirect_after` string, nullable

## Response `200`

Successful Response

- AuthorizationResponse
  - `integration` IntegrationConnectionResponse, required
    - `id` string, required
    - `integration_id` string, required
    - `organization_id` string, required
    - `workspace_id` string, nullable
    - `user_id` string, nullable
    - `secret_id` string, required
    - `name` string, nullable
    - `params` object, nullable
    - `connected_with_deployed_workflow` boolean
    - `contributes_to_carrier_pool` boolean
    - `preferred_load_identifier` 'EXTERNAL_REFERENCE_ID' | 'TMS_DISPLAY_REFERENCE_ID'
    - `past_pickup_grace_days` integer
    - `equipment_length_feet` object
    - `default_equipment_length_feet` integer, nullable
  - `is_authorized` boolean, required
  - `redirect_url` string, nullable, required
  - `credentials_verified` boolean, nullable: True when the credentials were exercised against the provider and accepted. False when the integration declares itself untestable, so the connection was saved without a check and may fail when first used. Null for OAuth flows, which authorize by redirect.
  - `credentials_message` string, nullable: User-facing result of the credential check.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/mentium/apis/mentium-api.md) - [All operations](https://skmtc.dev/mentium/apis/mentium-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mentium/apis/mentium-api/revisions/b4ed8e59432e?raw)