Retrieve All Third Party

Overview Endpoint Reference Responses

Overview

The GET /api/hub/external-integration/third-parties endpoint returns all Third Party records in the Hub. Results are paginated and can be sorted by any supported field.

What you can do

✓Retrieve a paginated list of all Third Party records in the Hub

✓Control page size, page number, and sort order via query parameters

✓Reference the full response schema including contacts, external contacts, industry sectors, contract dates, company address, and contracts

Prerequisites

✓A valid OAuth 2.0 bearer token

Endpoint Reference

Method

GET

Content-Type

application/json

URL

api/hub/external-integration/third-parties

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/third-parties'

Responses

Success Response

Code: 200 OK

{
  "content": [
    {
      "internalId": "uuid",
      "name": "string",
      "notes": "string",
      "description": "string",
      "identifier": "string",
      "accountId": "uuid",
      "created": "timestamp",
      "ownerIds": [
        "uuid"
      ],
      "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"
            }
          ]
        }
      ],
      "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"
        }
      ],
      "role": "enum: see Company Roles in Appendix",
      "industrySectors": [
        {
          "sector": "enum: see Industry Sectors in Appendix",
          "name": "enum: see Industry Sectors in Appendix"
        }
      ],
      "type": "enum: see Third Party Types in Appendix",
      "contractStartDate": "date",
      "contractEndDate": "date",
      "owningCompanyEntityIds": [
        "uuid"
      ],
      "ccpaQuestions": [
        "enum: see CCPA Questions in Appendix"
      ],
      "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"
        }
      ],
      "website": "string",
      "publiclyTraded": true,
      "stockSymbol": "TDD",
      "revenueLowerBound": 1000000,
      "revenueUpperBound": 2499999,
      "employeeCountLowerBound": 20,
      "employeeCountUpperBound": 49,
      "companyAddress": {
        "email": "[e-mail]",
        "phone": "123-456-7890",
        "address": "123 Main Street",
        "city": "Vancouver",
        "location": {
          "countryName": "Canada",
          "countryTwoLetterCode": "CA",
          "countryThreeLetterCode": "CAN",
          "countryRegionName": null,
          "globalRegionName": "North America",
          "stateName": "British Columbia",
          "stateShortValue": "BC",
          "provinceName": "British Columbia",
          "provinceShortValue": "BC"
        },
        "zip": "12345",
        "role": "Contact"
      },
      "contracts": [
        {
          "type": "COMPLIANCE",
          "name": "Compliance Certification or Attestation",
          "notes": "",
          "contractStartDate": null,
          "contractEndDate": null
        }
      ]
    }
  ],
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "size": 0,
  "sort": {},
  "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/third-parties  ·  support.trustarc.com