Integrations
Inspect integration configurations and billing plans, search repositories, and list webhooks for your team or project.
Retrieve an integration configuration.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | ID of the configuration to check |
teamId | string | No | Team ID to use for this operation. |
slug | string | No | Team slug to use for this operation. Use instead of teamId. |
Get a list of webhooks
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | string | No | The project ID. |
teamId | string | No | Team ID to use for this operation. |
slug | string | No | Team slug to use for this operation. Use instead of teamId. |
List integration billing plans.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
integrationIdOrSlug | string | Yes | The integration ID or slug. |
integrationConfigurationId | string | No | - |
productIdOrSlug | string | Yes | The integration product ID or slug. |
metadata | string | No | - |
source | string | No | Allowed values: "marketplace", "deploy-button", "external", "v0", "resource-claims", "cli", "oauth", "backoffice", "import-recommended-integrations", "organization". |
teamId | string | No | Team ID to use for this operation. |
slug | string | No | Team slug to use for this operation. Use instead of teamId. |
Returns products available for an integration configuration. Each product includes a metadataSchema field with the JSON Schema for required and optional metadata fields.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | ID of the integration configuration |
teamId | string | No | Team ID to use for this operation. |
slug | string | No | Team slug to use for this operation. Use instead of teamId. |
Get configurations for the authenticated user or team.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
view | string | Yes | Whether to list account-level or project-level integration configurations. Allowed values: "account", "project". |
installationType | string | No | Allowed values: "marketplace", "external", "provisioning". |
integrationIdOrSlug | string | No | ID of the integration |
teamId | string | No | Team ID to use for this operation. |
slug | string | No | Team slug to use for this operation. Use instead of teamId. |
List git repositories linked to namespace by provider.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
query | string | No | - |
namespaceId | string | number | null | No | - |
provider | string | No | Allowed values: "github", "github-limited", "github-custom-host", "gitlab", "bitbucket", "cursor-origin". |
installationId | string | No | - |
host | string | No | The custom Git host if using a custom Git provider, like GitHub Enterprise Server |
teamId | string | No | Team ID to use for this operation. |
slug | string | No | Team slug to use for this operation. Use instead of teamId. |
Was this helpful?