Get connector info

Get connector info

Authorizations

x-api-key

string

header

required

API key for authentication, you can easily get it from the dashboard after login or if you are using CLI, you can get it from the composio whoami command

Path Parameters

integrationId

string

required

Response

200 - application/json

appId

string

required

The ID of the application this connector belongs to. You can find available apps using the GET /api/v1/apps endpoint.

appName

string

required

The name of the application this connector integrates with.

authConfig

object

required

Configuration object containing authentication settings. Sensitive values will be redacted. The structure varies based on the authScheme.

enabled

boolean

required

Whether this connector is currently active and can be used to create new connections. Can be toggled using the connector management endpoints.

expectedInputFields

object[]

required

List of fields that need to be collected from users to set up a connection using this connector. These fields should be included when calling POST /api/v1/connectedAccounts.

Show child attributes

expectedInputFields.default

object

required

Default value for this field if none is provided. Set to null if no default exists.

expectedInputFields.description

string

required

Detailed explanation of what this field is used for and any special requirements or formatting needed.

expectedInputFields.display_name

string

required

Human-readable label that will be shown to users when they need to input this field.

expectedInputFields.expected_from_customer

boolean

required

Indicates if this field needs to be provided by the end user rather than being automatically populated.

expectedInputFields.is_secret

boolean

required

If true, this field contains sensitive information and should be handled securely (e.g. passwords, API keys).

expectedInputFields.name

string

required

The unique identifier/key for this input field that will be used when submitting values. Must be URL-safe.

expectedInputFields.required

boolean

required

Indicates if this field must be provided for the connector to function properly.

expectedInputFields.type

string

required

The data type of this field. Common types include 'string', 'number', 'boolean', etc.

logo

string

required

URL to the application's logo image that can be displayed in the UI.

useComposioAuth

boolean

required

When true, indicates that this connector uses Composio's built-in authentication handling rather than custom authentication logic.

authScheme

string

The authentication method used by this connector. Refer to the API documentation for supported authentication schemes.

createdAt

string

ISO 8601 timestamp of when this connector was created.

defaultConnectorId

string

If this is a custom connector, this field may reference the original template connector it was based on.

deleted

boolean

Soft deletion status of the connector. If true, the connector has been marked for deletion but may still exist in the system.

id

string

Unique identifier for the connector. You can use this ID when calling endpoints like POST /api/v1/connectedAccounts to create connections.

name

string

The display name of this specific connector configuration.

updatedAt

string

ISO 8601 timestamp of when this connector was last modified.