Overview
The GET /api/hub/external-integration/business-processes endpoint returns all Business Processes in the Hub. Results are paginated and can be sorted by any supported field.
What you can do
✓Retrieve a paginated list of all Business Processes in the Hub
✓Control page size, page number, and sort order via query parameters
✓Reference the full response schema including pagination metadata
Prerequisites
✓A valid OAuth 2.0 bearer token
Endpoint Reference
Method
GET
Content-Type
application/json
URL
api/hub/external-integration/business-processes
Query Parameters
Required JSON Parameters
| Name | Value | Description |
|---|---|---|
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'
Responses
Success Response
Code: 200 OK
{
"content": [
{
"accountId": "string",
"additionalDataElements": [
{
"categoryId": "string",
"categoryName": "string",
"custom": true,
"dataElement": "string",
"dataElementCategory": "string",
"id": "string",
"identifier": "string",
"name": "string",
"type": "Confidential"
}
],
"additionalProcessingPurposes": [
"string"
],
"contact": {
"address": "string",
"city": "string",
"email": "string",
"fullName": "string",
"location": {
"countryName": "string",
"countryRegionName": "string",
"countryThreeLetterCode": "string",
"countryTwoLetterCode": "string",
"globalRegionName": "string",
"provinceName": "string",
"provinceShortValue": "string",
"stateName": "string",
"stateShortValue": "string"
},
"phone": "string",
"role": "string",
"zip": "string"
},
"created": "2020-08-07T23:20:28.904Z",
"dataFlowDataElements": [
{
"categoryId": "string",
"categoryName": "string",
"custom": true,
"dataElement": "string",
"dataElementCategory": "string",
"id": "string",
"identifier": "string",
"name": "string",
"type": "Confidential"
}
],
"dataFlowProcessingPurposes": [
"string"
],
"dataRecipients": [
{
"category": "string",
"dataRecipientLocations": [
{
"countryName": "string",
"countryRegionName": "string",
"countryThreeLetterCode": "string",
"countryTwoLetterCode": "string",
"globalRegionName": "string",
"provinceName": "string",
"provinceShortValue": "string",
"stateName": "string",
"stateShortValue": "string"
}
],
"dataRecipientType": "string"
}
],
"dataRetention": {
"dataRetentionType": "Days",
"description": "string",
"summary": "string",
"type": "string",
"value": "string"
},
"dataSubjectVolumeName": "string",
"dataSubjects": [
{
"category": "string",
"dataSubjectLocations": [
{
"countryName": "string",
"countryRegionName": "string",
"countryThreeLetterCode": "string",
"countryTwoLetterCode": "string",
"globalRegionName": "string",
"provinceName": "string",
"provinceShortValue": "string",
"stateName": "string",
"stateShortValue": "string"
}
],
"dataSubjectType": "string"
}
],
"department": "string",
"description": "string",
"externalDataSource": "string",
"externalId": "string",
"identifier": "string",
"internalId": "string",
"itSystems": [
{
"accountId": "string",
"contact": {
"address": "string",
"city": "string",
"email": "string",
"fullName": "string",
"location": {
"countryName": "string",
"countryRegionName": "string",
"countryThreeLetterCode": "string",
"countryTwoLetterCode": "string",
"globalRegionName": "string",
"provinceName": "string",
"provinceShortValue": "string",
"stateName": "string",
"stateShortValue": "string"
},
"phone": "string",
"role": "string",
"zip": "string"
},
"created": "2020-08-07T23:20:28.904Z",
"dataElementObjects": [
{
"categoryId": "string",
"categoryName": "string",
"custom": true,
"dataElement": "string",
"dataElementCategory": "string",
"id": "string",
"identifier": "string",
"name": "string",
"type": "Confidential"
}
],
"dataElements": [
"string"
],
"dataRetention": {
"dataRetentionType": "Days",
"description": "string",
"summary": "string",
"type": "string",
"value": "string"
},
"dataSubjectTypes": [
{
"category": "string",
"dataSubjectLocations": [
{
"countryName": "string",
"countryRegionName": "string",
"countryThreeLetterCode": "string",
"countryTwoLetterCode": "string",
"globalRegionName": "string",
"provinceName": "string",
"provinceShortValue": "string",
"stateName": "string",
"stateShortValue": "string"
}
],
"dataSubjectType": "string"
}
],
"dataSubjectVolumeName": "string",
"description": "string",
"externalDataSource": "string",
"externalId": "string",
"identifier": "string",
"internalId": "string",
"locations": [
{
"countryName": "string",
"countryRegionName": "string",
"countryThreeLetterCode": "string",
"countryTwoLetterCode": "string",
"globalRegionName": "string",
"provinceName": "string",
"provinceShortValue": "string",
"stateName": "string",
"stateShortValue": "string"
}
],
"name": "string",
"notes": "string",
"ownedBy": "string",
"ownerId": "string",
"processingPurposes": [
"string"
],
"tags": [
{
"groupName": "string",
"values": [
"string"
]
}
]
}
],
"locations": [
{
"countryName": "string",
"countryRegionName": "string",
"countryThreeLetterCode": "string",
"countryTwoLetterCode": "string",
"globalRegionName": "string",
"provinceName": "string",
"provinceShortValue": "string",
"stateName": "string",
"stateShortValue": "string"
}
],
"name": "string",
"notes": "string",
"otherSecurityControl": "string",
"ownerId": "string",
"owningCompanyEntity": "string",
"processingPurposeLegalBases": [
{
"legalBasis": "string",
"processingPurpose": "string"
}
],
"role": "DATA_CONTROLLER",
"securityControls": [
"string"
],
"status": "string",
"tags": [
{
"groupName": "string",
"values": [
"string"
]
}
]
}
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {
"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}
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 · support.trustarc.com