# Personal Connector Configuration Object

div
strong
🔨 In Development
 — This section is still being developed and may change.


Represents a user-specific configuration for a personal connector. Configurations store connector settings, credentials, and access permissions, enabling users to connect their personal accounts to external services.

## Properties

**`id`** string

Unique identifier for the configuration. Format: `pconf_` followed by alphanumeric characters.

**`object`** string

Object type identifier. Always `personal_connector.configuration`.

**`userId`** string optional

User ID who owns this configuration. Either `userId` or `apiKeyId` must be present.

**`apiKeyId`** string optional

API key ID associated with this configuration. Either `userId` or `apiKeyId` must be present.

**`organizationId`** string

Organization ID this configuration belongs to.

**`personalConnectorId`** string

Reference to the personal connector definition. Links to a [Personal Connector Object](/docs/api-reference/objects/personal-connector-object).

**`name`** string

User-friendly name for this configuration. Example: `"My GitHub Account"`, `"Work ClickUp"`.

**`configuration`** object

Connector-specific configuration settings. Structure varies by connector type.

details
summary
Show example configurations by connector type
**GitHub Configuration:**


```json
{
  "repository": "acme/backend",
  "branch": "main",
  "paths": ["src/", "docs/"]
}
```

**ClickUp Configuration:**


```json
{
  "workspaceId": "12345",
  "listId": "67890",
  "defaultPriority": 3
}
```

**Jira Configuration:**


```json
{
  "projectKey": "PROJ",
  "issueType": "Task",
  "defaultAssignee": "user@example.com"
}
```

**Teams Configuration:**


```json
{
  "teamId": "team-abc123",
  "channelId": "channel-xyz789"
}
```

**Custom MCP Configuration:**


```json
{
  "endpoint": "https://my-server.com/api",
  "customSettings": {...}
}
```

**`credentials`** object optional

Encrypted authentication credentials. Structure varies by authentication method. **Note:** Credentials are encrypted at rest and never returned in API responses.

details
summary
Show credential formats by auth method
**API Key:**


```json
{
  "type": "api_key",
  "apiKey": "encrypted_value"
}
```

**OAuth2:**


```json
{
  "type": "oauth2",
  "accessToken": "encrypted_value",
  "refreshToken": "encrypted_value",
  "expiresAt": "2025-12-31T23:59:59Z"
}
```

**Bearer Token:**


```json
{
  "type": "bearer",
  "token": "encrypted_value"
}
```

**`enabled`** boolean

Whether this configuration is currently active. Defaults to `true`.

**`healthStatus`** string

Current health status of the connector. Values:

- `healthy` - Connection is working
- `unhealthy` - Connection failed or credentials invalid
- `unknown` - Not yet tested


**`lastSyncAt`** string optional

ISO 8601 timestamp of the last successful tool discovery or health check.

**`lastError`** string optional

Last error message if the connector is unhealthy.

**`description`** string optional

Optional description explaining the configuration's purpose.

**`metadata`** object optional

Custom key-value pairs for tagging and filtering configurations.

**`createdAt`** string

ISO 8601 timestamp when the configuration was created.

**`updatedAt`** string

ISO 8601 timestamp when the configuration was last updated.

## Example Objects

### GitHub Configuration


```json
{
  "id": "pconf_abc123",
  "object": "personal_connector.configuration",
  "userId": "user_xyz789",
  "organizationId": "org_123",
  "personalConnectorId": "pcon_github",
  "name": "My GitHub Account",
  "configuration": {
    "repository": "acme/backend",
    "branch": "main",
    "paths": ["src/", "docs/"],
    "fileTypes": [".py", ".md"]
  },
  "enabled": true,
  "healthStatus": "healthy",
  "lastSyncAt": "2025-10-07T10:00:00Z",
  "description": "Access to backend repository",
  "metadata": {
    "environment": "production"
  },
  "createdAt": "2025-10-01T00:00:00Z",
  "updatedAt": "2025-10-07T10:00:00Z"
}
```

### ClickUp Configuration


```json
{
  "id": "pconf_def456",
  "object": "personal_connector.configuration",
  "userId": "user_xyz789",
  "organizationId": "org_123",
  "personalConnectorId": "pcon_clickup",
  "name": "Work ClickUp",
  "configuration": {
    "workspaceId": "12345",
    "listId": "67890",
    "defaultPriority": 3,
    "defaultStatus": "To Do"
  },
  "enabled": true,
  "healthStatus": "healthy",
  "lastSyncAt": "2025-10-07T09:30:00Z",
  "description": "Engineering team tasks",
  "metadata": {
    "team": "engineering"
  },
  "createdAt": "2025-10-01T00:00:00Z",
  "updatedAt": "2025-10-07T09:30:00Z"
}
```

### Unhealthy Configuration


```json
{
  "id": "pconf_ghi789",
  "object": "personal_connector.configuration",
  "userId": "user_xyz789",
  "organizationId": "org_123",
  "personalConnectorId": "pcon_jira",
  "name": "Jira Integration",
  "configuration": {
    "projectKey": "PROJ",
    "issueType": "Task"
  },
  "enabled": true,
  "healthStatus": "unhealthy",
  "lastSyncAt": "2025-10-06T15:00:00Z",
  "lastError": "Authentication failed: Invalid API token",
  "createdAt": "2025-10-01T00:00:00Z",
  "updatedAt": "2025-10-06T15:00:00Z"
}
```