Get-Integration

Summary

Retrieves an existing integration.

Get-Integration
    -Id

Returns a integration object.

Parameters

Examples

Get an existing integration

This example retrieves a specific integration and outputs it as JSON.

# Retrieve a specific integration by id
$integration = Get-Integration -Id 1

Write-Output "Retrieved integration $($integration.IntegrationId)"

# Convert the integration to output as JSON
$jsonOutput = $integration | ConvertTo-Json -Depth 10

# For debug purposes, convert the integration to output as JSON so we can see the available fields
Write-Output ""
Write-Output "JSON Results:"

$jsonOutput = $integration | ConvertTo-Json -Depth 10

Write-Output $jsonOutput

JSON results:

Retrieved integration 1

JSON Results:
{
  "IntegrationId": 1,
  "Name": "Relativity",
  "Identifier": "https://my-company.relativity.one",
  "Description": "Allows Agility Blue the ability to communicate and interract with Relativity",
  "Enabled": true,
  "Visible": true,
  "ConfigurationIsValid": true,
  "CreatedByFullName": "Max Miller",
  "CreatedById": "510e109b-6ff5-4442-9670-cd5e3cd82a7a",
  "CreatedOn": "2017-08-10T18:54:20.1750537-05:00",
  "CreatedBy": null,
  "LastUpdatedByFullName": "Max Miller",
  "LastUpdatedById": "510e109b-6ff5-4442-9670-cd5e3cd82a7a",
  "LastUpdatedOn": "2025-02-28T12:46:51.1555729+00:00",
  "LastUpdatedBy": null
}