GET
/
v1
/
integrations
/
configuration
/
{id}
import { Vercel } from "@vercel/sdk";

const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await vercel.integrations.getConfiguration({
    id: "icfg_cuwj0AdCdH3BwWT4LPijCC7t",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });

  // Handle the result
  console.log(result);
}

run();
{
  "completedAt": 1558531915505,
  "createdAt": 1558531915505,
  "id": "icfg_3bwCLgxL8qt5kjRLcv2Dit7F",
  "integrationId": "oac_xzpVzcUOgcB1nrVlirtKhbWV",
  "ownerId": "kr1PsOIzqEL5Xg6M4VZcZosf",
  "projects": [
    "prj_xQxbutw1HpL6HLYPAzt5h75m8NjO"
  ],
  "source": "marketplace",
  "slug": "slack",
  "teamId": "team_nLlpyC6RE1qxydlFKbrxDlud",
  "type": "integration-configuration",
  "updatedAt": 1558531915505,
  "userId": "kr1PsOIzqEL5Xg6M4VZcZosf",
  "scopes": [
    "read:project",
    "read-write:log-drain"
  ],
  "disabledAt": 1558531915505,
  "deletedAt": 1558531915505,
  "deleteRequestedAt": 1558531915505,
  "disabledReason": "disabled-by-owner",
  "installationType": "marketplace"
}

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Path Parameters

​
id
string
required

ID of the configuration to check

Example:

"icfg_cuwj0AdCdH3BwWT4LPijCC7t"

Query Parameters

​
teamId
string

The Team identifier to perform the request on behalf of.

Example:

"team_1a2b3c4d5e6f7g8h9i0j1k2l"

​
slug
string

The Team slug to perform the request on behalf of.

Example:

"my-team-url-slug"

Response

200
application/json

The configuration with the provided id

​
createdAt
number
required

A timestamp that tells you when the configuration was created

Example:

1558531915505

​
id
string
required

The unique identifier of the configuration

Example:

"icfg_3bwCLgxL8qt5kjRLcv2Dit7F"

​
integrationId
string
required

The unique identifier of the app the configuration was created for

Example:

"oac_xzpVzcUOgcB1nrVlirtKhbWV"

​
ownerId
string
required

The user or team ID that owns the configuration

Example:

"kr1PsOIzqEL5Xg6M4VZcZosf"

​
slug
string
required

The slug of the integration the configuration is created for.

Example:

"slack"

​
type
enum<string>
required
Available options:
integration-configuration
​
updatedAt
number
required

A timestamp that tells you when the configuration was updated.

Example:

1558531915505

​
userId
string
required

The ID of the user that created the configuration.

Example:

"kr1PsOIzqEL5Xg6M4VZcZosf"

​
scopes
string[]
required

The resources that are allowed to be accessed by the configuration.

Example:
["read:project", "read-write:log-drain"]
​
completedAt
number

A timestamp that tells you when the configuration was installed successfully

Example:

1558531915505

​
projects
string[]

When a configuration is limited to access certain projects, this will contain each of the project ID it is allowed to access. If it is not defined, the configuration has full access.

Example:
["prj_xQxbutw1HpL6HLYPAzt5h75m8NjO"]
​
source
enum<string>

Source defines where the configuration was installed from. It is used to analyze user engagement for integration installations in product metrics.

Available options:
marketplace,
deploy-button,
external,
v0
Example:

"marketplace"

​
teamId
string | null

When the configuration was created for a team, this will show the ID of the team.

Example:

"team_nLlpyC6RE1qxydlFKbrxDlud"

​
disabledAt
number

A timestamp that tells you when the configuration was disabled. Note: Configurations can be disabled when the associated user loses access to a team. They do not function during this time until the configuration is 'transferred', meaning the associated user is changed to one with access to the team.

Example:

1558531915505

​
deletedAt
number | null

A timestamp that tells you when the configuration was deleted.

Example:

1558531915505

​
deleteRequestedAt
number | null

A timestamp that tells you when the configuration deletion has been started for cases when the deletion needs to be settled/approved by partners, such as when marketplace invoices have been paid.

Example:

1558531915505

​
disabledReason
enum<string>
Available options:
disabled-by-owner,
feature-not-available,
disabled-by-admin,
original-owner-left-the-team,
account-plan-downgrade,
original-owner-role-downgraded
​
installationType
enum<string>

Defines the installation type. - 'external' integrations are installed via the existing integrations flow - 'marketplace' integrations are natively installed: - when accepting the TOS of a partner during the store creation process - if undefined, assume 'external'

Available options:
marketplace,
external