Retrieve IT Systems Using External ID

Overview Endpoint Reference Responses

Overview

The GET /api/hub/external-integration/it-systems/external-id/{external-id} endpoint returns a single IT System record matched by its External ID.

What you can do

✓Retrieve a single IT System by its External ID

✓Access full IT System details including locations, tags, contacts, external contacts, data subjects, data recipients, data elements, processing purposes, and risk

Prerequisites

✓A valid OAuth 2.0 bearer token

Endpoint Reference

Method

GET

Content-Type

application/json

URL

api/hub/external-integration/it-systems/external-id/{external-id}

Required Path Parameters

Name	Value	Description
externalId	String	The External ID of the IT System to retrieve.

Sample curl Request

curl -X GET \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <Auth Token>' \
  'api/hub/it-systems/external-id/{external-id}'

Responses

Success Response

Code: 200 OK

{
  "internalId": "uuid",
  "name": "string",
  "notes": "string",
  "description": "string",
  "identifier": "string",
  "accountId": "uuid",
  "created": "timestamp",
  "ownerIds": [
    "string"
  ],
  "externalId": "string",
  "externalDataSource": "string",
  "locations": [
    {
      "countryName": "string",
      "countryTwoLetterCode": "string",
      "countryThreeLetterCode": "string",
      "countryRegionName": "string",
      "globalRegionName": "string",
      "stateName": "string",
      "stateShortValue": "string",
      "provinceName": "string",
      "provinceShortValue": "string"
    }
  ],
  "tags": [
    {
      "groupName": "string",
      "tagValues": [
        {
          "value": "string",
          "externalId": "string"
        }
      ]
    }
  ],
  "dataRetention": {
    "value": "string",
    "description": "string",
    "summary": "string",
    "dataRetentionType": "enum: Days, Weeks, Months, Years, Other"
  },
  "contacts": [
    {
      "fullName": "string",
      "email": "string",
      "phone": "string",
      "address": "string",
      "city": "string",
      "location": {
        "countryName": "string",
        "countryTwoLetterCode": "string",
        "countryThreeLetterCode": "string",
        "countryRegionName": "string",
        "globalRegionName": "string",
        "stateName": "string",
        "stateShortValue": "string",
        "provinceName": "string",
        "provinceShortValue": "string"
      },
      "zip": "string",
      "role": "enum: see Contact Roles in Appendix"
    }
  ],
  "ownedBy": "string",
  "ownedById": "uuid",
  "dataSubjectVolumeName": "string",
  "externalContacts": [
    {
      "fullName": "string",
      "email": "string",
      "phone": "string",
      "address": "string",
      "city": "string",
      "location": {
        "countryName": "string",
        "countryTwoLetterCode": "string",
        "countryThreeLetterCode": "string",
        "countryRegionName": "string",
        "globalRegionName": "string",
        "stateName": "string",
        "stateShortValue": "string",
        "provinceName": "string",
        "provinceShortValue": "string"
      },
      "zip": "string",
      "role": "enum: see Contact Roles in Appendix"
    }
  ],
  "dataSubjectTypes": [
    {
      "identifier": "string",
      "dataSubjectType": "string",
      "category": "string",
      "dataSubjectLocations": [
        {
          "countryName": "string",
          "countryTwoLetterCode": "string",
          "countryThreeLetterCode": "string",
          "countryRegionName": "string",
          "globalRegionName": "string",
          "stateName": "string",
          "stateShortValue": "string",
          "provinceName": "string",
          "provinceShortValue": "string"
        }
      ]
    }
  ],
  "dataRecipientTypes": [
    {
      "identifier": "string",
      "category": "string",
      "dataRecipientType": "string",
      "dataRecipientLocations": [
        {
          "countryName": "string",
          "countryTwoLetterCode": "string",
          "countryThreeLetterCode": "string",
          "countryRegionName": "string",
          "globalRegionName": "string",
          "stateName": "string",
          "stateShortValue": "string",
          "provinceName": "string",
          "provinceShortValue": "string"
        }
      ]
    }
  ],
  "dataElementObjects": [
    {
      "identifier": "string",
      "dataElement": "string",
      "dataElementCategory": "string"
    }
  ],
  "processingPurposeObjects": [
    {
      "identifier": "string",
      "processingPurpose": "string",
      "processingPurposeCategory": "string"
    }
  ],
  "aiUsed": "enum: YES, NO, UNKNOWN, INCOMPLETE",
  "aiNotes": "string",
  "website": "string",
  "risk": {
    "calculatedRisk": "MEDIUM",
    "userEvaluatedRisk": null,
    "inherentRisk": "MEDIUM_REVIEW",
    "residualRisk": null,
    "inherentRiskSeverity": 1,
    "inherentRiskLikelihood": 3
  }
}

Error Responses

Code: 400 Bad Request

Code: 401 Unauthorized

Code: 403 Forbidden

Code: 404 Not Found

TrustArc  ·  Hub API — GET /api/hub/external-integration/it-systems/external-id/{external-id}  ·  support.trustarc.com