Overview
The GET /api/hub/external-integration/business-processes/external-id/{external-id} endpoint returns a single Business Process record matched by its External ID.
What you can do
✓Retrieve a single Business Process by its External ID
✓Access full Business Process details including IT Systems, data subjects, data recipients, retention, risk, and owner contact information
Prerequisites
✓A valid OAuth 2.0 bearer token
Endpoint Reference
Method
GET
Content-Type
application/json
URL
api/hub/external-integration/business-processes/external-id/{external-id}
Query Parameters
Required Query Parameters
| Name | Value | Description |
|---|---|---|
externalId
|
String | The External ID of the Business Process to retrieve. |
page
|
Integer | The results page to retrieve (0…N). |
size
|
Integer | Number of records per page. |
sort
|
asc | desc |
Sorting criteria in the format:
property,asc|desc.
Multiple sort criteria are supported.
|
Sample curl Request
curl -X GET \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <Auth Token>' \
'api/hub/business-processes/external-id/{external-id}'
Responses
Success Response
Code: 200 OK
{
"internalId": "uuid",
"name": "string",
"notes": "string",
"description": "string",
"identifier": "string",
"accountId": "uuid",
"created": "timestamp",
"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"
},
"status": "string",
"dataSubjectVolumeName": "string",
"securityControls": [
"string"
],
"otherSecurityControl": "string",
"processingPurposeLegalBases": [
{
"processingPurpose": "string",
"legalBasis": "string"
}
],
"businessProcessOwners": [
{
"department": "string",
"role": "enum: see Company Roles in Appendix",
"owningCompanyEntity": "string",
"owningCompanyEntityId": "uuid",
"ownerContact": {
"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"
}
}
],
"aiUsed": "enum: YES, NO, UNKNOWN, INCOMPLETE",
"aiNotes": "string",
"dataSubjects": [
{
"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"
}
]
}
],
"dataRecipients": [
{
"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"
}
]
}
],
"itSystems": [
{
"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": "Days"
},
"ownedBy": "string",
"ownedById": "uuid",
"dataSubjectVolumeName": "string",
"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"
}
]
}
],
"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/business-processes/external-id/{external-id} · support.trustarc.com