v13

latestOpenAPI 3.0.32026-07-31359869.4 MB
marketplace

Get Integration Resource

Get a resource by its partner ID.

get/v1/installations/{integrationConfigurationId}/resources/{resourceId}

Path parameters

integrationConfigurationIdstring required

The ID of the integration configuration (installation) the resource belongs to

The ID of the integration configuration (installation) the resource belongs to

resourceIdstring required

The ID provided by the 3rd party provider for the given resource

The ID provided by the 3rd party provider for the given resource

Response

idstring required

The ID provided by the 3rd party provider for the given resource

internalIdstring required

The ID assigned by Vercel for the given resource

namestring required

The name of the resource as it is recorded in Vercel

status'error' | 'onboarding' | 'pending' | 'ready' | 'resumed' | 'suspended' | 'uninstalled'

The current status of the resource

productIdstring required

The ID of the product the resource is derived from

billingPlanIdstring

The ID of the billing plan the resource is subscribed to, if applicable

metadataobject

The configured metadata for the resource as defined by its product's Metadata Schema